highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2026-02-11 01:33:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

kernel: Add Purpose section to header documentation

Browse Source
This commit is contained in:
TheCharlatan
2025-03-26 12:09:28 +01:00
parent 7e9f00bcc1
commit 6c7a34f3b0
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/kernel/bitcoinkernel.h
View File

@@ -48,6 +48,14 @@ extern "C" {
/** /**
* @page remarks Remarks * @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 * @section context Context
* *
* The library provides a built-in static constant kernel context. This static * The library provides a built-in static constant kernel context. This static