Paul Bakker | 3c18a83 | 2012-01-23 09:44:43 +0000 | [diff] [blame] | 1 | /** |
Jaeden Amero | 25facdd | 2018-01-23 15:36:58 +0000 | [diff] [blame] | 2 | * \file doc_mainpage.h |
| 3 | * |
| 4 | * \brief Main page documentation file. |
| 5 | */ |
| 6 | /* |
Manuel Pégourié-Gonnard | 8119dad | 2015-08-06 10:59:26 +0200 | [diff] [blame] | 7 | * |
Bence Szépkúti | 1e14827 | 2020-08-07 13:07:28 +0200 | [diff] [blame] | 8 | * Copyright The Mbed TLS Contributors |
Dave Rodgman | e3c0585 | 2023-11-03 12:21:36 +0000 | [diff] [blame] | 9 | * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 10 | */ |
| 11 | |
| 12 | /** |
David Horstmann | 7ba04a2 | 2024-09-03 17:36:30 +0100 | [diff] [blame] | 13 | * @mainpage Mbed TLS v4.0.0 API Documentation |
Paul Bakker | dcbfdcc | 2013-09-10 16:16:50 +0200 | [diff] [blame] | 14 | * |
Gilles Peskine | 0204470 | 2025-06-25 15:40:01 +0200 | [diff] [blame^] | 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 notable 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 | * |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 36 | */ |