mbedtls/doxygen/input/doc_mainpage.h

/**
 * \file doc_mainpage.h
 *
 * \brief Main page documentation file.
 */
/*
 *
 *  Copyright The Mbed TLS Contributors
 *  SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
 */

/**
 * @mainpage Mbed TLS v4.0.0 API Documentation
 *
 * 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
 * https://www.doxygen.nl for more information on Doxygen)
 */
- Made changes for 1.1.1 release 2012-01-23 09:44:43 +00:00			`/**`
doxygen: Remove copyright block from Doxygen comments Remove the copyright block from the Doxygen comments, to clean up the detailed description in the generated Doxygen output. Also, add \file and \brief tags to all headers in doxygen/input. 2018-01-23 15:36:58 +00:00			`* \file doc_mainpage.h`
			`*`
			`* \brief Main page documentation file.`
			`*/`
			`/*`
Make sure all .h files have license information Even if they don't need it: this simplifies future audits. 2015-08-06 08:59:26 +00:00			`*`
Update copyright notices to use Linux Foundation guidance As a result, the copyright of contributors other than Arm is now acknowledged, and the years of publishing are no longer tracked in the source files. Also remove the now-redundant lines declaring that the files are part of MbedTLS. This commit was generated using the following script: # ======================== #!/bin/sh # Find files find '(' -path './.git' -o -path './3rdparty' ')' -prune -o -type f -print \| xargs sed -bi ' # Replace copyright attribution line s/Copyright.Arm./Copyright The Mbed TLS Contributors/I # Remove redundant declaration and the preceding line $!N /This file is part of Mbed TLS/Id P D ' # ======================== Signed-off-by: Bence Szépkúti <bence.szepkuti@arm.com> 2020-08-07 11:07:28 +00:00			`* Copyright The Mbed TLS Contributors`
Header updates Signed-off-by: Dave Rodgman <dave.rodgman@arm.com> 2023-11-03 12:21:36 +00:00			`* SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`*/`

			`/**`
Bump version to 4.0.0 Signed-off-by: David Horstmann <david.horstmann@arm.com> 2024-09-03 16:36:30 +00:00			`* @mainpage Mbed TLS v4.0.0 API Documentation`
Updated doxygen documentation in header files and HTML pages 2013-09-10 14:16:50 +00:00			`*`
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 <david.horstmann@arm.com> 2023-05-04 14:22:35 +00:00			`* This documentation describes the internal structure of Mbed TLS. It was`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`* automatically generated from specially formatted comment blocks in`
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 <david.horstmann@arm.com> 2023-05-04 14:22:35 +00:00			`* Mbed TLS's source code using Doxygen. (See`
Update broken link to doxygen homepage Signed-off-by: David Horstmann <david.horstmann@arm.com> 2023-05-04 14:20:21 +00:00			`* https://www.doxygen.nl for more information on Doxygen)`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`*/`