From 8ba67aef0d8ad051728ce4f321423d843d768c48 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Wed, 25 Jun 2025 15:40:11 +0200 Subject: [PATCH] Rendered documentation: info about private elements in public headers Signed-off-by: Gilles Peskine --- doxygen/input/doc_mainpage.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doxygen/input/doc_mainpage.h b/doxygen/input/doc_mainpage.h index 6b4343b5e0..597eee9928 100644 --- a/doxygen/input/doc_mainpage.h +++ b/doxygen/input/doc_mainpage.h @@ -33,4 +33,20 @@ * configuration header files mbedtls/mbedtls_config.h and * psa/crypto_config.h. * + * ## Private interfaces + * + * For technical reasons, the rendered documentation includes elements + * that are not considered part of the stable API. Private elements may + * be removed or may have their semantics changed in a future minor release + * without notice. + * + * The following elements are considered private: + * + * - Any header file whose path contains `/private`, and its contents + * (unless re-exported and documented in another non-private header). + * - Any structure or union field whose name starts with `private_`. + * - Any preprocessor macro that is just listed with its automatically + * rendered parameter list, value and location. Macros are part of + * the API only if their documentation includes have custom text. + * */