Skip to content

Commit d3a3d6a

Browse files
committed
doxygen: Update for Mbed Crypto
Remove references to the X.509, NET, and SSL modules. Update text from "Mbed TLS" to "Mbed Crypto". Update version number.
1 parent e879a45 commit d3a3d6a

File tree

3 files changed

+8
-58
lines changed

3 files changed

+8
-58
lines changed

doxygen/input/doc_mainpage.h

Lines changed: 8 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
*/
66
/*
77
*
8-
* Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8+
* Copyright (C) 2006-2019, ARM Limited, All Rights Reserved
99
* SPDX-License-Identifier: Apache-2.0
1010
*
1111
* Licensed under the Apache License, Version 2.0 (the "License"); you may
@@ -24,73 +24,26 @@
2424
*/
2525

2626
/**
27-
* @mainpage mbed TLS v2.17.0 source code documentation
27+
* @mainpage Mbed Crypto v0.1.0 source code documentation
2828
*
2929
* This documentation describes the internal structure of mbed TLS. It was
3030
* automatically generated from specially formatted comment blocks in
3131
* mbed TLS's source code using Doxygen. (See
3232
* http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen)
3333
*
34-
* mbed TLS has a simple setup: it provides the ingredients for an SSL/TLS
35-
* implementation. These ingredients are listed as modules in the
36-
* \ref mainpage_modules "Modules section". This "Modules section" introduces
37-
* the high-level module concepts used throughout this documentation.\n
38-
* Some examples of mbed TLS usage can be found in the \ref mainpage_examples
39-
* "Examples section".
34+
* Mbed Crypto provides an implementation of the PSA Crypto API. The library is
35+
* comprised of a number of independent modules, listed in the \ref
36+
* mainpage_modules "Modules section". This "Modules section" introduces the
37+
* high-level module concepts used throughout this documentation.
4038
*
4139
* @section mainpage_modules Modules
4240
*
43-
* mbed TLS supports SSLv3 up to TLSv1.2 communication by providing the
44-
* following:
45-
* - TCP/IP communication functions: listen, connect, accept, read/write.
46-
* - SSL/TLS communication functions: init, handshake, read/write.
47-
* - X.509 functions: CRT, CRL and key handling
41+
* Mbed Crypto provides the following modules:
4842
* - Random number generation
4943
* - Hashing
5044
* - Encryption/decryption
5145
*
5246
* Above functions are split up neatly into logical interfaces. These can be
53-
* used separately to provide any of the above functions or to mix-and-match
54-
* into an SSL server/client solution that utilises a X.509 PKI. Examples of
55-
* such implementations are amply provided with the source code.
47+
* used separately to provide any of the above functions or to mix-and-match.
5648
*
57-
* Note that mbed TLS does not provide a control channel or (multiple) session
58-
* handling without additional work from the developer.
59-
*
60-
* @section mainpage_examples Examples
61-
*
62-
* Example server setup:
63-
*
64-
* \b Prerequisites:
65-
* - X.509 certificate and private key
66-
* - session handling functions
67-
*
68-
* \b Setup:
69-
* - Load your certificate and your private RSA key (X.509 interface)
70-
* - Setup the listening TCP socket (TCP/IP interface)
71-
* - Accept incoming client connection (TCP/IP interface)
72-
* - Initialise as an SSL-server (SSL/TLS interface)
73-
* - Set parameters, e.g. authentication, ciphers, CA-chain, key exchange
74-
* - Set callback functions RNG, IO, session handling
75-
* - Perform an SSL-handshake (SSL/TLS interface)
76-
* - Read/write data (SSL/TLS interface)
77-
* - Close and cleanup (all interfaces)
78-
*
79-
* Example client setup:
80-
*
81-
* \b Prerequisites:
82-
* - X.509 certificate and private key
83-
* - X.509 trusted CA certificates
84-
*
85-
* \b Setup:
86-
* - Load the trusted CA certificates (X.509 interface)
87-
* - Load your certificate and your private RSA key (X.509 interface)
88-
* - Setup a TCP/IP connection (TCP/IP interface)
89-
* - Initialise as an SSL-client (SSL/TLS interface)
90-
* - Set parameters, e.g. authentication mode, ciphers, CA-chain, session
91-
* - Set callback functions RNG, IO
92-
* - Perform an SSL-handshake (SSL/TLS interface)
93-
* - Verify the server certificate (SSL/TLS interface)
94-
* - Write/read data (SSL/TLS interface)
95-
* - Close and cleanup (all interfaces)
9649
*/

doxygen/mbedtls.doxyfile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1618,7 +1618,6 @@ PREDEFINED = WIN32 \
16181618
P2MP \
16191619
P2MP_SERVER \
16201620
USE_CRYPTO \
1621-
USE_SSL \
16221621
ENABLE_PLUGIN \
16231622
ENABLE_MANAGEMENT \
16241623
ENABLE_OCC \

include/mbedtls/dhm.h

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,6 @@ int mbedtls_dhm_calc_secret( mbedtls_dhm_context *ctx,
298298
void mbedtls_dhm_free( mbedtls_dhm_context *ctx );
299299

300300
#if defined(MBEDTLS_ASN1_PARSE_C)
301-
/** \ingroup x509_module */
302301
/**
303302
* \brief This function parses DHM parameters in PEM or DER format.
304303
*
@@ -317,7 +316,6 @@ int mbedtls_dhm_parse_dhm( mbedtls_dhm_context *dhm, const unsigned char *dhmin,
317316
size_t dhminlen );
318317

319318
#if defined(MBEDTLS_FS_IO)
320-
/** \ingroup x509_module */
321319
/**
322320
* \brief This function loads and parses DHM parameters from a file.
323321
*

0 commit comments

Comments
 (0)