1
0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-07-28 00:21:48 +03:00

Rendered documentation: info about private elements in public headers

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine
2025-06-25 15:40:11 +02:00
parent 0204470f38
commit 8ba67aef0d

View File

@ -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.
*
*/