Skip to content

Commit 6c7a34f

Browse files
committed
kernel: Add Purpose section to header documentation
1 parent 7e9f00b commit 6c7a34f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/kernel/bitcoinkernel.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ extern "C" {
4848
/**
4949
* @page remarks Remarks
5050
*
51+
* @section purpose Purpose
52+
*
53+
* This header currently exposes an API for interacting with parts of Bitcoin
54+
* Core's consensus code. Users can validate blocks, iterate the block index,
55+
* read block and undo data from disk, and validate scripts. The header is
56+
* unversioned and not stable yet. Users should expect breaking changes. It is
57+
* also not yet included in releases of Bitcoin Core.
58+
*
5159
* @section context Context
5260
*
5361
* The library provides a built-in static constant kernel context. This static

0 commit comments

Comments
 (0)