1 /**
2  * \file doc_mainpage.h
3  *
4  * \brief Main page documentation file.
5  */
6 /*
7  *
8  *  Copyright The Mbed TLS Contributors
9  *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
10  */
11 
12 /**
13  * @mainpage Mbed TLS v4.0.0-beta API Documentation
14  *
15  * This documentation describes the application programming interface (API)
16  * of Mbed TLS.
17  * It was automatically generated from specially formatted comment blocks in
18  * Mbed TLS's source code using [Doxygen](https://www.doxygen.nl).
19  *
20  * ## Main entry points
21  *
22  * You can explore the full API from the “Files” or “Files list” section.
23  * Locate the header file for the module that you are interested in and
24  * explore its contents.
25  *
26  * Some parts of the API are best explored from the “Topics” or
27  * “Group list” section.
28  * This is notably the case for the PSA Cryptography API.
29  * Note that many parts of the API are not classified under a topic and
30  * can only be seen through the file structure.
31  *
32  * For information on configuring the library at compile time, see the
33  * configuration header files mbedtls/mbedtls_config.h and
34  * psa/crypto_config.h.
35  *
36  * ## Private interfaces
37  *
38  * For technical reasons, the rendered documentation includes elements
39  * that are not considered part of the stable API. Private elements may
40  * be removed or may have their semantics changed in a future minor release
41  * without notice.
42  *
43  * The following elements are considered private:
44  *
45  * - Any header file whose path contains `/private`, and its contents
46  *   (unless re-exported and documented in another non-private header).
47  * - Any structure or union field whose name starts with `private_`.
48  * - Any preprocessor macro that is just listed with its automatically
49  *   rendered parameter list, value and location. Macros are part of
50  *   the API only if their documentation has custom text.
51  *
52  */
53