laantungir
/
bitcoin
mirror of https://github.com/bitcoin/bitcoin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

kernel: Add Purpose section to header documentation

This commit is contained in:
TheCharlatan 2025-03-26 12:09:28 +01:00
parent 2db540a173
commit 1db7bde6d2
No known key found for this signature in database
GPG Key ID: 9B79B45691DB4173
1 changed files with 8 additions and 0 deletions
Show Stats 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 und 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