Skip to content

Commit

Permalink
Fix docs on asynchronous API. Fix Vector35#665
Browse files Browse the repository at this point in the history
  • Loading branch information
xusheng6 committed Nov 21, 2024
1 parent 7a5b384 commit d360ce1
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions api/python/debuggercontroller.py
Original file line number Diff line number Diff line change
Expand Up @@ -823,7 +823,7 @@ def go(self) -> bool:
The call is asynchronous and returns before the target stops.
:return: the reason for the stop
:return: whether the operation is successfully requested
"""
return dbgcore.BNDebuggerGo(self.handle)

Expand All @@ -834,7 +834,7 @@ def go_reverse(self) -> bool:
The call is asynchronous and returns before the target stops.
:return: the reason for the stop
:return: whether the operation is successfully requested
"""
return dbgcore.BNDebuggerGoReverse(self.handle)

Expand All @@ -855,7 +855,7 @@ def step_into(self, il: binaryninja.FunctionGraphType = binaryninja.FunctionGrap
The call is asynchronous and returns before the target stops.
:param il: optional IL level to perform the operation at
:return: the reason for the stop
:return: whether the operation is successfully requested
"""
return dbgcore.BNDebuggerStepInto(self.handle, il)

Expand All @@ -876,7 +876,7 @@ def step_into_reverse(self, il: binaryninja.FunctionGraphType = binaryninja.Func
The call is asynchronous and returns before the target stops.
:param il: optional IL level to perform the operation at
:return: the reason for the stop
:return: whether the operation is successfully requested
"""
return dbgcore.BNDebuggerStepIntoReverse(self.handle, il)

Expand All @@ -897,7 +897,7 @@ def step_over(self, il: binaryninja.FunctionGraphType = binaryninja.FunctionGrap
The call is asynchronous and returns before the target stops.
:param il: optional IL level to perform the operation at
:return: the reason for the stop
:return: whether the operation is successfully requested
"""
return dbgcore.BNDebuggerStepOver(self.handle, il)

Expand All @@ -918,7 +918,7 @@ def step_over_reverse(self, il: binaryninja.FunctionGraphType = binaryninja.Func
The call is asynchronous and returns before the target stops.
:param il: optional IL level to perform the operation at
:return: the reason for the stop
:return: whether the operation is successfully requested
"""
return dbgcore.BNDebuggerStepOverReverse(self.handle, il)

Expand All @@ -938,7 +938,7 @@ def step_return(self) -> bool:
The call is asynchronous and returns before the target stops.
:return: the reason for the stop
:return: whether the operation is successfully requested
"""
return dbgcore.BNDebuggerStepReturn(self.handle)

Expand All @@ -958,7 +958,7 @@ def step_return_reverse(self) -> bool:
The call is asynchronous and returns before the target stops.
:return: the reason for the stop
:return: whether the operation is successfully requested
"""
return dbgcore.BNDebuggerStepReturnReverse(self.handle)

Expand All @@ -971,8 +971,9 @@ def run_to(self, address) -> bool:
Internally, the debugger places breakpoints on these addresses, resume the target, and wait for the target
to break. Then the debugger removes the added breakpoints.
The call is asynchronous and returns before the target stops.
The call is asynchronous and returns before the target stops.
:return: whether the operation is successfully requested
"""
if isinstance(address, int):
address = [address]
Expand Down Expand Up @@ -1125,6 +1126,7 @@ def run_to_and_wait(self, address) -> DebugStopReason:
The call is blocking and only returns when the target stops.
:return: the reason for the stop
"""
if isinstance(address, int):
address = [address]
Expand Down

0 comments on commit d360ce1

Please sign in to comment.