From 37321bfc779f47e7000f35c63676276efbda965f Mon Sep 17 00:00:00 2001
From: Alexander Taylor <alex@vector35.com>
Date: Thu, 29 Jun 2023 10:42:26 -0400
Subject: Clarifying parts of the basic block APIs.

---
 binaryninjaapi.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'binaryninjaapi.h')

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;
 	};
-- 
cgit v1.3.1