summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlexander Taylor <alex@vector35.com>2023-06-29 10:42:26 -0400
committerAlexander Taylor <alex@vector35.com>2023-06-29 10:55:13 -0400
commit37321bfc779f47e7000f35c63676276efbda965f (patch)
tree366c0a9b5bc51d8d0d349cb2ebbcee3d4970cac3
parent09e327e88c979de7229e8cb139f9d55a65c881fd (diff)
Clarifying parts of the basic block APIs.
-rw-r--r--binaryninjaapi.h7
-rw-r--r--python/basicblock.py2
2 files changed, 5 insertions, 4 deletions
diff --git a/binaryninjaapi.h b/binaryninjaapi.h
index 7baa9606..8a592ae2 100644
--- a/binaryninjaapi.h
+++ b/binaryninjaapi.h
@@ -8517,7 +8517,7 @@ namespace BinaryNinja {
struct BasicBlockEdge
{
BNBranchType type;
- Ref<BasicBlock> target;
+ Ref<BasicBlock> target; //! The source or destination of the edge, depending on context
bool backEdge;
bool fallThrough;
};
@@ -8757,9 +8757,10 @@ namespace BinaryNinja {
bool GetInstructionContainingAddress(uint64_t addr, uint64_t* start);
- /*! Basic block source block
+ /*! Gets the corresponding assembly-level basic block for this basic block
+ (which is itself, if called on an assembly-level basic block).
- \return Basic block source block
+ \return Basic Block
*/
Ref<BasicBlock> GetSourceBlock() const;
};
diff --git a/python/basicblock.py b/python/basicblock.py
index 56dccfdb..0195bbdc 100644
--- a/python/basicblock.py
+++ b/python/basicblock.py
@@ -207,7 +207,7 @@ class BasicBlock:
@property
def source_block(self) -> Optional['BasicBlock']:
- """Basic block source block (read-only)"""
+ """The corresponding assembly-level basic block for this basic block (read-only)"""
block = core.BNGetBasicBlockSource(self.handle)
if block is None:
return None