doc: add integer type conventions in btck api remarks
What the developer wrote
Authored by Alexander Wiederin
doc: add integer type conventions in btck api remarks
What changed, and why it matters
This commit only adds documentation comments to a header file. It explains which integer types the Bitcoin Kernel C API uses for different kinds of values. No code behavior was changed.
No action required; this is a documentation-only change with no security relevance.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff inserts a new ‘@section types Type conventions’ paragraph into the Doxygen/API remarks in src/kernel/bitcoinkernel.h. It documents that fixed-width integer types (int32_t, uint32_t) are used for data values such as heights, while plain int and unsigned int are used for boolean-like values and flags. There are no functional changes.
Changed components
src/kernel/bitcoinkernel.h (documentation only)Inspect captured patch +6 / −0
diff --git a/src/kernel/bitcoinkernel.h b/src/kernel/bitcoinkernel.h
index a0483b96..cd837573 100644
--- a/src/kernel/bitcoinkernel.h
+++ b/src/kernel/bitcoinkernel.h
@@ -112,6 +112,12 @@ extern "C" {
* object.
*
* Array lengths follow the pointer argument they describe.
+ *
+ * @section types Type conventions
+ *
+ * Fixed-width integer types (e.g. int32_t, uint32_t) are used for data values
+ * such as heights. Plain int and unsigned int are used for boolean-like values
+ * and flags.
*/
/**
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.