kernel: Add Purpose section to header documentation
What the developer wrote
Authored by TheCharlatan
kernel: Add Purpose section to header documentation
What changed, and why it matters
This commit only adds plain-English documentation to a header file. It describes what the bitcoinkernel library is for and warns that the API is unstable and not yet released. No code behavior changed.
No action needed; this is a documentation-only change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The diff adds a new Doxygen ‘@section purpose Purpose’ block to src/kernel/bitcoinkernel.h. It documents the current API surface (consensus validation, block index iteration, block/undo disk reads, script validation) and notes the header is unversioned, unstable, and not shipped in releases. There are no functional changes.
Changed components
src/kernel/bitcoinkernel.hInspect captured patch +8 / −0
diff --git a/src/kernel/bitcoinkernel.h b/src/kernel/bitcoinkernel.h
index 14cd8145..99ae2bd6 100644
--- a/src/kernel/bitcoinkernel.h
+++ b/src/kernel/bitcoinkernel.h
@@ -48,6 +48,14 @@ extern "C" {
/**
* @page remarks Remarks
*
+ * @section purpose Purpose
+ *
+ * This header currently exposes an API for interacting with parts of Bitcoin
+ * Core's consensus code. Users can validate blocks, iterate the block index,
+ * read block and undo data from disk, and validate scripts. The header is
+ * unversioned and not stable yet. Users should expect breaking changes. It is
+ * also not yet included in releases of Bitcoin Core.
+ *
* @section context Context
*
* The library provides a built-in static constant kernel context. This static
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.