From 6c7a34f3b0bd39ef7a1520aac56e12f78e5cc969 Mon Sep 17 00:00:00 2001 From: TheCharlatan Date: Wed, 26 Mar 2025 12:09:28 +0100 Subject: [PATCH] kernel: Add Purpose section to header documentation --- src/kernel/bitcoinkernel.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/kernel/bitcoinkernel.h b/src/kernel/bitcoinkernel.h index 14cd8145b11..99ae2bd67ae 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