lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-07-29 11:41:15 +03:00
Code Activity

Slight improvement to the Doxygen entry point

Browse Source 
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine
2025-06-25 15:40:01 +02:00
parent c10c233676
commit 0204470f38
1 changed files with 21 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doxygen/input/doc_mainpage.h
View File

@ -12,8 +12,25 @@
/** /**
* @mainpage Mbed TLS v4.0.0 API Documentation * @mainpage Mbed TLS v4.0.0 API Documentation
* *
* This documentation describes the internal structure of Mbed TLS. It was * This documentation describes the application programming interface (API)
* automatically generated from specially formatted comment blocks in * of Mbed TLS.
* Mbed TLS's source code using Doxygen. (See * It was automatically generated from specially formatted comment blocks in
* https://www.doxygen.nl for more information on Doxygen) * Mbed TLS's source code using [Doxygen](https://www.doxygen.nl).
*
* ## Main entry points
*
* You can explore the full API from the “Files” or “Files list” section.
* Locate the header file for the module that you are interested in and
* explore its contents.
*
* Some parts of the API are best explored from the “Topics” or
* “Group list” section.
* This is notable the case for the PSA Cryptography API.
* Note that many parts of the API are not classified under a topic and
* can only be seen through the file structure.
*
* For information on configuring the library at compile time, see the
* configuration header files mbedtls/mbedtls_config.h and
* psa/crypto_config.h.
*
*/ */