lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-08-08 17:42:09 +03:00
Code Activity

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

7
doxygen/input/doc_ssltls.h
View File

@@ -5,16 +5,16 @@
/**
* @addtogroup ssltls_communication_module SSL/TLS communication module
*
*
* The SSL/TLS communication module provides the means to create an SSL/TLS
* communication channel.
* communication channel.
*
* The basic provisions are:
* - initialise an SSL/TLS context (see \c ssl_init()).
* - perform an SSL/TLS handshake (see \c ssl_handshake()).
* - read/write (see \c ssl_read() and \c ssl_write()).
* - notify a peer that conection is being closed (see \c ssl_close_notify()).
*
*
* Many aspects of such a channel are set through parameters and callback
* functions:
* - the endpoint role: client or server.
@@ -24,7 +24,6 @@
* - the ciphers to use for encryption/decryption.
* - session control functions.
* - X.509 parameters for certificate-handling and key exchange.
*
*
* This module can be used to create an SSL/TLS server and client and to provide a basic
* framework to setup and communicate through an SSL/TLS communication channel.\n