kernel: doc: explain return value for `btck_WriteBytes` callback
What the developer wrote
Authored by Sebastian Falbesoner
kernel: doc: explain return value for `btck_WriteBytes` callback
This is the only non-void callback type, so it makes sense to document what
implementers should return.
What changed, and why it matters
This commit only adds a documentation comment explaining that the btck_WriteBytes callback should return 0 to indicate success. No code behavior was changed.
No action required. This is a non-security documentation change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds a single line of Doxygen-style documentation to the function pointer typedef for btck_WriteBytes in src/kernel/bitcoinkernel.h. It does not modify any logic, signatures, call sites, or error handling. The change is purely informational for implementers of the Bitcoin Kernel library interface.
Changed components
src/kernel/bitcoinkernel.hInspect captured patch +2 / −0
diff --git a/src/kernel/bitcoinkernel.h b/src/kernel/bitcoinkernel.h
index 5427e776..57c88c12 100644
--- a/src/kernel/bitcoinkernel.h
+++ b/src/kernel/bitcoinkernel.h
@@ -349,6 +349,8 @@ typedef void (*btck_ValidationInterfaceBlockDisconnected)(void* user_data, btck_
/**
* Function signature for serializing data.
+ *
+ * Returns 0 to indicate success.
*/
typedef int (*btck_WriteBytes)(const void* bytes, size_t size, void* userdata);
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.