summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorJordan Wiens <github@psifertex.com>2019-07-29 18:01:35 -0400
committerJordan Wiens <github@psifertex.com>2019-07-29 18:01:49 -0400
commita8e440c27cf81b91d040a6b3ac495b8dfb9ada8e (patch)
treea5154c04db8e8e35c8aae9fa0bf1a7e769fdff43 /python
parent53c6d163da2c10fa3643e8e105fee101b31c0396 (diff)
add documentation for folder groupings of other register_for functions
Diffstat (limited to 'python')
-rw-r--r--python/plugin.py14
1 files changed, 7 insertions, 7 deletions
diff --git a/python/plugin.py b/python/plugin.py
index 9e1380c8..27549c3d 100644
--- a/python/plugin.py
+++ b/python/plugin.py
@@ -343,7 +343,7 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
"""
``register_for_address`` Register a plugin to be called with an address argument
- :param str name: name of the plugin
+ :param str name: name of the plugin (use 'Folder\\Name' to have the menu item nested in a folder)
:param str description: description of the plugin
: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
@@ -362,7 +362,7 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
"""
``register_for_range`` Register a plugin to be called with a range argument
- :param str name: name of the plugin
+ :param str name: name of the plugin (use 'Folder\\Name' to have the menu item nested in a folder)
:param str description: description of the plugin
: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
@@ -381,7 +381,7 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
"""
``register_for_function`` Register a plugin to be called with a function argument
- :param str name: name of the plugin
+ :param str name: name of the plugin (use 'Folder\\Name' to have the menu item nested in a folder)
:param str description: description of the plugin
: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
@@ -400,7 +400,7 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
"""
``register_for_low_level_il_function`` Register a plugin to be called with a low level IL function argument
- :param str name: name of the plugin
+ :param str name: name of the plugin (use 'Folder\\Name' to have the menu item nested in a folder)
:param str description: description of the plugin
: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
@@ -419,7 +419,7 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
"""
``register_for_low_level_il_instruction`` Register a plugin to be called with a low level IL instruction argument
- :param str name: name of the plugin
+ :param str name: name of the plugin (use 'Folder\\Name' to have the menu item nested in a folder)
:param str description: description of the plugin
: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
@@ -438,7 +438,7 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
"""
``register_for_medium_level_il_function`` Register a plugin to be called with a medium level IL function argument
- :param str name: name of the plugin
+ :param str name: name of the plugin (use 'Folder\\Name' to have the menu item nested in a folder)
:param str description: description of the plugin
: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
@@ -457,7 +457,7 @@ class PluginCommand(with_metaclass(_PluginCommandMetaClass, object)):
"""
``register_for_medium_level_il_instruction`` Register a plugin to be called with a medium level IL instruction argument
- :param str name: name of the plugin
+ :param str name: name of the plugin (use 'Folder\\Name' to have the menu item nested in a folder)
:param str description: description of the plugin
: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