eden-emu/mbedtls
15
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated doxygen documentation in header files and HTML pages

Browse source
This commit is contained in:
Paul Bakker 2013-09-10 16:16:50 +02:00
parent 6ec34fb53d
commit dcbfdcc177
21 changed files with 120 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

38
doxygen/input/doc_mainpage.h
View file

@ -5,23 +5,22 @@
/**
* @mainpage PolarSSL v1.2.6 source code documentation
*
*
* This documentation describes the internal structure of PolarSSL. It was
* automatically generated from specially formatted comment blocks in
* PolarSSL's source code using Doxygen. (See
* http://www.stack.nl/~dimitri/doxygen/ for more information on Doxygen)
*
* PolarSSL 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
*
* PolarSSL 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 PolarSSL usage can be found in the \ref mainpage_examples
* "Examples section".
*
*
*
* @section mainpage_modules Modules
*
* PolarSSL supports SSLv3 up to TLSv1.2 communication by providing the
*
* PolarSSL 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.
@ -30,19 +29,19 @@
* - 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
* there is also an OpenSSL wrapper provided.\n
* 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 PolarSSL does not provide a control channel or (multiple) session
* handling.
* handling without additional work from the developer.
*
* @section mainpage_examples Examples
*
*
* Example server setup:
*
* \b Prerequisites:
* \b Prerequisites:
* - X.509 certificate and private key
* - session handling functions
*
@ -57,7 +56,6 @@
* - Read/write data (SSL/TLS interface)
* - Close and cleanup (all interfaces)
*
*
* Example client setup:
*
* \b Prerequisites:
@ -75,6 +73,4 @@
* - Verify the server certificate (SSL/TLS interface)
* - Write/read data (SSL/TLS interface)
* - Close and cleanup (all interfaces)
*
*
*/