diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2024-02-29 13:21:16 -0500 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2024-02-29 13:21:16 -0500 |
| commit | 9e1de1b3dda78250012f4e03963e4d8916a8c8cd (patch) | |
| tree | d4499c7b2aed659ca1fe361b31bd921e7c6f4d10 /python | |
| parent | b7c8e9bfbae0eec8d7be47cd42f61c14542cc28c (diff) | |
link from traverse APIs to examples
Diffstat (limited to 'python')
| -rw-r--r-- | python/binaryview.py | 2 | ||||
| -rw-r--r-- | python/highlevelil.py | 4 | ||||
| -rw-r--r-- | python/lowlevelil.py | 4 | ||||
| -rw-r--r-- | python/mediumlevelil.py | 4 |
4 files changed, 7 insertions, 7 deletions
diff --git a/python/binaryview.py b/python/binaryview.py index c623e44f..247e369a 100644 --- a/python/binaryview.py +++ b/python/binaryview.py @@ -9103,7 +9103,7 @@ class BinaryView: :py:func:`add_expression_parser_magic_value` API. Notably, the debugger adds all register values into the expression parser so they can be used directly when navigating. The register values can be referenced like `$rbp`, `$x0`, etc. For more details, refer to the related - [debugger docs](https://docs.binary.ninja/guide/debugger/index.html#navigating-the-binary). + [debugger docs](https://docs.binary.ninja/guide/debugger/index.html#navigating-the-binary)_. :param str expression: Arithmetic expression to be evaluated :param int here: (optional) Base address for relative expressions, defaults to zero diff --git a/python/highlevelil.py b/python/highlevelil.py index c9126eb5..7efbcbb8 100644 --- a/python/highlevelil.py +++ b/python/highlevelil.py @@ -783,7 +783,7 @@ class HighLevelILInstruction(BaseILInstruction): """ ``traverse`` is a generator that allows you to traverse the HLIL AST in a depth-first manner. It will yield the result of the callback function for each node in the AST. Arguments can be passed to the callback function using - ``args`` and ``kwargs``. + ``args`` and ``kwargs``. See the `Developer Docs <https://docs.binary.ninja/dev/concepts.html#walking-ils>`_ for more examples. :param Callable[[HighLevelILInstruction, Any], Any] cb: The callback function to call for each node in the HighLevelILInstruction :param Any args: Custom user-defined arguments @@ -2552,7 +2552,7 @@ class HighLevelILFunction: def traverse(self, cb: Callable[['HighLevelILInstruction', Any], Any], *args: Any, **kwargs: Any) -> Iterator[Any]: """ ``traverse`` iterates through all the instructions in the HighLevelILInstruction and calls the callback function for - each instruction and sub-instruction. + each instruction and sub-instruction. See the `Developer Docs <https://docs.binary.ninja/dev/concepts.html#walking-ils>`_ for more examples. :param Callable[[HighLevelILInstruction, Any], Any] cb: The callback function to call for each node in the HighLevelILInstruction :param Any args: Custom user-defined arguments diff --git a/python/lowlevelil.py b/python/lowlevelil.py index e12623a4..9b2bd4ae 100644 --- a/python/lowlevelil.py +++ b/python/lowlevelil.py @@ -683,7 +683,7 @@ class LowLevelILInstruction(BaseILInstruction): """ ``traverse`` is a generator that allows you to traverse the LowLevelILInstruction in a depth-first manner. It will yield the result of the callback function for each node in the tree. Arguments can be passed to the callback function using - ``args`` and ``kwargs``. + ``args`` and ``kwargs``. See the `Developer Docs <https://docs.binary.ninja/dev/concepts.html#walking-ils>`_ for more examples. :param Callable[[LowLevelILInstruction, Any], Any] cb: The callback function to call for each node in the LowLevelILInstruction :param Any args: Custom user-defined arguments @@ -3258,7 +3258,7 @@ class LowLevelILFunction: def traverse(self, cb: Callable[['LowLevelILInstruction', Any], Any], *args: Any, **kwargs: Any) -> Iterator[Any]: """ ``traverse`` iterates through all the instructions in the LowLevelILFunction and calls the callback function for - each instruction and sub-instruction. + each instruction and sub-instruction. See the `Developer Docs <https://docs.binary.ninja/dev/concepts.html#walking-ils>`_ for more examples. :param Callable[[LowLevelILInstruction, Any], Any] cb: The callback function to call for each node in the LowLevelILInstruction :param Any args: Custom user-defined arguments diff --git a/python/mediumlevelil.py b/python/mediumlevelil.py index 412d3c19..05eeb449 100644 --- a/python/mediumlevelil.py +++ b/python/mediumlevelil.py @@ -430,7 +430,7 @@ class MediumLevelILInstruction(BaseILInstruction): """ ``traverse`` is a generator that allows you to traverse the MediumLevelILInstruction in a depth-first manner. It will yield the result of the callback function for each node in the tree. Arguments can be passed to the callback function using - ``args`` and ``kwargs``. + ``args`` and ``kwargs``. See the `Developer Docs <https://docs.binary.ninja/dev/concepts.html#walking-ils>`_ for more examples. :param Callable[[MediumLevelILInstruction, Any], Any] cb: The callback function to call for each node in the MediumLevelILInstruction :param Any args: Custom user-defined arguments @@ -3206,7 +3206,7 @@ class MediumLevelILFunction: def traverse(self, cb: Callable[['MediumLevelILInstruction', Any], Any], *args: Any, **kwargs: Any) -> Iterator[Any]: """ ``traverse`` iterates through all the instructions in the MediumLevelILInstruction and calls the callback function for - each instruction and sub-instruction. + each instruction and sub-instruction. See the `Developer Docs <https://docs.binary.ninja/dev/concepts.html#walking-ils>`_ for more examples. :param Callable[[MediumLevelILInstruction, Any], Any] cb: Callback function that takes a HighLevelILInstruction and returns a value :param Any args: Custom user-defined arguments |
