summaryrefslogtreecommitdiff
path: root/python
diff options
context:
space:
mode:
authorXusheng <xusheng@vector35.com>2021-02-05 20:38:37 +0800
committerXusheng <xusheng@vector35.com>2021-02-05 20:38:37 +0800
commit726b4e76013f118b35d7b517001eefc8f861d617 (patch)
tree0903246bfe0e8d9b7cacafb33764ad8d44d19c0f /python
parent6ca08f688ab555660ccbfeeb748a2740e58b2ba2 (diff)
improve the documentation of binaryview callbacks
Diffstat (limited to 'python')
-rw-r--r--python/binaryview.py13
1 files changed, 12 insertions, 1 deletions
diff --git a/python/binaryview.py b/python/binaryview.py
index 21850a54..193cf8b4 100644
--- a/python/binaryview.py
+++ b/python/binaryview.py
@@ -275,7 +275,7 @@ class BinaryViewEvent(object):
>>> def callback(bv):
... print('start: 0x%x' % bv.start)
...
- >>> BinaryViewEvent.add_binaryview_finalized_event(callback)
+ >>> BinaryViewType.add_binaryview_finalized_event(callback)
"""
@classmethod
def register(cls, event_type, callback):
@@ -996,10 +996,21 @@ class BinaryViewType(with_metaclass(_BinaryViewTypeMetaclass, object)):
@staticmethod
def add_binaryview_finalized_event(callback):
+ """
+ `add_binaryview_finalized_event` adds a callback that gets executed
+ when new binaryview is finalized.
+ For more details, please refer to the documentation of BinaryViewEvent.
+ """
BinaryViewEvent.register(BinaryViewEventType.BinaryViewFinalizationEvent, callback)
@staticmethod
def add_binaryview_initial_analysis_completion_event(callback):
+ """
+ `add_binaryview_initial_analysis_completion_event` adds a callback
+ that gets executed after the initial analysis, as well as linear
+ sweep and signature matcher (if they are configured to run) completed.
+ For more details, please refer to the documentation of BinaryViewEvent.
+ """
BinaryViewEvent.register(BinaryViewEventType.BinaryViewInitialAnalysisCompletionEvent, callback)