capstone.h: document that for instruction or when detail mode is OFF,…

… the detail pointer is irrelevant, regardless of its value
mkravchik · Oct 12, 2014 · 2c8b262 · 2c8b262
1 parent 1a83cea
commit 2c8b262
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/include/capstone.h b/include/capstone.h
@@ -236,8 +236,9 @@ typedef struct cs_insn {
 	// NOTE: detail pointer is only valid when both requirements below are met:
 	// (1) CS_OP_DETAIL = CS_OPT_ON
 	// (2) Engine is not in Skipdata mode (CS_OP_SKIPDATA option set to CS_OPT_ON)
-	//     Note: when in Skipdata mode, even if this pointer is not NULL,
-	//     its content is irrelevant.
+	//
+	// NOTE 2: when in Skipdata mode, or when detail mode is OFF, even if this pointer
+	//     is not NULL, its content is still irrelevant.
 	cs_detail *detail;
 } cs_insn;