From 07b1cf91e10f238d5dbcc8cc5e931adac87341a4 Mon Sep 17 00:00:00 2001 From: David Horstmann Date: Thu, 4 May 2023 15:14:01 +0100 Subject: [PATCH 1/3] Remove most of the doxygen mainpage Since the API docs are now published as part of the larger documentation, it makes no sense to give an overview of Mbed TLS in the mainpage as this is already given elsewhere. Signed-off-by: David Horstmann --- doxygen/input/doc_mainpage.h | 63 ------------------------------------ 1 file changed, 63 deletions(-) diff --git a/doxygen/input/doc_mainpage.h b/doxygen/input/doc_mainpage.h index 4c762463d..a844afd70 100644 --- a/doxygen/input/doc_mainpage.h +++ b/doxygen/input/doc_mainpage.h @@ -28,67 +28,4 @@ * automatically generated from specially formatted comment blocks in * mbed TLS's source code using Doxygen. (See * http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen) - * - * mbed TLS has a simple setup: it provides the ingredients for an SSL/TLS - * implementation. These ingredients are listed as modules in the - * \ref mainpage_modules "Modules section". This "Modules section" introduces - * the high-level module concepts used throughout this documentation.\n - * Some examples of mbed TLS usage can be found in the \ref mainpage_examples - * "Examples section". - * - * @section mainpage_modules Modules - * - * mbed TLS supports SSLv3 up to TLSv1.2 communication by providing the - * following: - * - TCP/IP communication functions: listen, connect, accept, read/write. - * - SSL/TLS communication functions: init, handshake, read/write. - * - X.509 functions: CRT, CRL and key handling - * - Random number generation - * - Hashing - * - Encryption/decryption - * - * Above functions are split up neatly into logical interfaces. These can be - * used separately to provide any of the above functions or to mix-and-match - * into an SSL server/client solution that utilises a X.509 PKI. Examples of - * such implementations are amply provided with the source code. - * - * Note that mbed TLS does not provide a control channel or (multiple) session - * handling without additional work from the developer. - * - * @section mainpage_examples Examples - * - * Example server setup: - * - * \b Prerequisites: - * - X.509 certificate and private key - * - session handling functions - * - * \b Setup: - * - Load your certificate and your private RSA key (X.509 interface) - * - Setup the listening TCP socket (TCP/IP interface) - * - Accept incoming client connection (TCP/IP interface) - * - Initialise as an SSL-server (SSL/TLS interface) - * - Set parameters, e.g. authentication, ciphers, CA-chain, key exchange - * - Set callback functions RNG, IO, session handling - * - Perform an SSL-handshake (SSL/TLS interface) - * - Read/write data (SSL/TLS interface) - * - Close and cleanup (all interfaces) - * - * Example client setup: - * - * \b Prerequisites: - * - X.509 certificate and private key - * - X.509 trusted CA certificates - * - * \b Setup: - * - Load the trusted CA certificates (X.509 interface) - * - Load your certificate and your private RSA key (X.509 interface) - * - Setup a TCP/IP connection (TCP/IP interface) - * - Initialise as an SSL-client (SSL/TLS interface) - * - Set parameters, e.g. authentication mode, ciphers, CA-chain, session - * - Set callback functions RNG, IO - * - Perform an SSL-handshake (SSL/TLS interface) - * - Verify the server certificate (SSL/TLS interface) - * - Write/read data (SSL/TLS interface) - * - Close and cleanup (all interfaces) */ From 1ef4dc9df905f0b82a9552640b52070e358fd67c Mon Sep 17 00:00:00 2001 From: David Horstmann Date: Thu, 4 May 2023 15:20:21 +0100 Subject: [PATCH 2/3] Update broken link to doxygen homepage Signed-off-by: David Horstmann --- doxygen/input/doc_mainpage.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doxygen/input/doc_mainpage.h b/doxygen/input/doc_mainpage.h index a844afd70..4e2c9373b 100644 --- a/doxygen/input/doc_mainpage.h +++ b/doxygen/input/doc_mainpage.h @@ -27,5 +27,5 @@ * This documentation describes the internal structure of mbed TLS. It was * automatically generated from specially formatted comment blocks in * mbed TLS's source code using Doxygen. (See - * http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen) + * https://www.doxygen.nl for more information on Doxygen) */ From 73474ed1218547d4d01a32f33fa8ff6dd25d4a4e Mon Sep 17 00:00:00 2001 From: David Horstmann Date: Thu, 4 May 2023 15:22:35 +0100 Subject: [PATCH 3/3] Minor cosmetic changes * Change "source code documentation" to "API documentation" for precision * Change "mbed TLS" to "Mbed TLS" following established convention * Use title case in the title Signed-off-by: David Horstmann --- doxygen/input/doc_mainpage.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doxygen/input/doc_mainpage.h b/doxygen/input/doc_mainpage.h index 4e2c9373b..bbf4ea2f4 100644 --- a/doxygen/input/doc_mainpage.h +++ b/doxygen/input/doc_mainpage.h @@ -22,10 +22,10 @@ */ /** - * @mainpage mbed TLS v2.28.3 source code documentation + * @mainpage Mbed TLS v2.28.3 API Documentation * - * This documentation describes the internal structure of mbed TLS. It was + * This documentation describes the internal structure of Mbed TLS. It was * automatically generated from specially formatted comment blocks in - * mbed TLS's source code using Doxygen. (See + * Mbed TLS's source code using Doxygen. (See * https://www.doxygen.nl for more information on Doxygen) */