summaryrefslogtreecommitdiff
path: root/python/plugin.py
diff options
context:
space:
mode:
Diffstat (limited to 'python/plugin.py')
-rw-r--r--python/plugin.py32
1 files changed, 16 insertions, 16 deletions
diff --git a/python/plugin.py b/python/plugin.py
index a3eafdde..afaf3032 100644
--- a/python/plugin.py
+++ b/python/plugin.py
@@ -281,8 +281,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
:param str name: name of the plugin
:param str description: description of the plugin
- :param action: function to call with the ``BinaryView`` as an argument
- :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view
+ :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` as an argument
+ :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view
:rtype: None
.. warning:: Calling ``register`` with the same function name will replace the existing function but will leak the memory of the original plugin.
@@ -300,8 +300,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
:param str name: name of the plugin
:param str description: description of the plugin
- :param action: function to call with the ``BinaryView`` and address as arguments
- :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view
+ :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and address as arguments
+ :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view
:rtype: None
.. warning:: Calling ``register_for_address`` with the same function name will replace the existing function but will leak the memory of the original plugin.
@@ -319,8 +319,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
:param str name: name of the plugin
:param str description: description of the plugin
- :param action: function to call with the ``BinaryView`` and ``AddressRange`` as arguments
- :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view
+ :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and :class:`~binaryninja.binaryview.AddressRange` as arguments
+ :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view
:rtype: None
.. warning:: Calling ``register_for_range`` with the same function name will replace the existing function but will leak the memory of the original plugin.
@@ -338,8 +338,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
:param str name: name of the plugin
:param str description: description of the plugin
- :param action: function to call with the ``BinaryView`` and a ``Function`` as arguments
- :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view
+ :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and a :class:`~binaryninja.function.Function` as arguments
+ :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view
:rtype: None
.. warning:: Calling ``register_for_function`` with the same function name will replace the existing function but will leak the memory of the original plugin.
@@ -357,8 +357,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
:param str name: name of the plugin
:param str description: description of the plugin
- :param action: function to call with the ``BinaryView`` and a ``LowLevelILFunction`` as arguments
- :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view
+ :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and a :class:`~binaryninja.mediumlevelil.LowLevelILFunction` as arguments
+ :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view
:rtype: None
.. warning:: Calling ``register_for_low_level_il_function`` with the same function name will replace the existing function but will leak the memory of the original plugin.
@@ -376,8 +376,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
:param str name: name of the plugin
:param str description: description of the plugin
- :param action: function to call with the ``BinaryView`` and a ``LowLevelILInstruction`` as arguments
- :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view
+ :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and a :class:`~binaryninja.mediumlevelil.LowLevelILInstruction` as arguments
+ :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view
:rtype: None
.. warning:: Calling ``register_for_low_level_il_instruction`` with the same function name will replace the existing function but will leak the memory of the original plugin.
@@ -395,8 +395,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
:param str name: name of the plugin
:param str description: description of the plugin
- :param action: function to call with the ``BinaryView`` and a ``MediumLevelILFunction`` as arguments
- :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view
+ :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and a :class:`~binaryninja.mediumlevelil.MediumLevelILFunction` as arguments
+ :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view
:rtype: None
.. warning:: Calling ``register_for_medium_level_il_function`` with the same function name will replace the existing function but will leak the memory of the original plugin.
@@ -414,8 +414,8 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
:param str name: name of the plugin
:param str description: description of the plugin
- :param action: function to call with the ``BinaryView`` and a ``MediumLevelILInstruction`` as arguments
- :param is_valid: optional argument of a function passed a ``BinaryView`` to determine whether the plugin should be enabled for that view
+ :param action: function to call with the :class:`~binaryninja.binaryview.BinaryView` and a :class:`~binaryninja.mediumlevelil.MediumLevelILInstruction` as arguments
+ :param is_valid: optional argument of a function passed a :class:`~binaryninja.binaryview.BinaryView` to determine whether the plugin should be enabled for that view
:rtype: None
.. warning:: Calling ``register_for_medium_level_il_instruction`` with the same function name will replace the existing function but will leak the memory of the original plugin.