riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: minor fixing for crypto module

Browse Source 
Moves the crypto module documentation to the right group and streamline the doxygen keywords.
This commit is contained in:
Oleg Hahm 2015-08-26 10:42:50 +02:00
parent aa0e990e3e
commit 4a8e897c0e
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
sys/crypto/doc.txt
View File

@ -8,10 +8,12 @@
/** /**
* @defgroup sys_crypto Crypto * @defgroup sys_crypto Crypto
* @ingroup sys
*
* @brief RIOT provides a collection of block cipher ciphers, different * @brief RIOT provides a collection of block cipher ciphers, different
operation modes and cryptographic hash algorithms. operation modes and cryptographic hash algorithms.
* *
* \section ciphers Ciphers * @section ciphers Ciphers
* *
* Riot supports the following block ciphers: * Riot supports the following block ciphers:
* * AES-128 * * AES-128
@ -25,7 +27,7 @@
* the generic API for block ciphers whenever possible. * the generic API for block ciphers whenever possible.
* *
* Example: * Example:
* \code * @code
* #include "crypto/ciphers.h" * #include "crypto/ciphers.h"
* *
* ciphter_t cipher; * ciphter_t cipher;
@ -36,14 +38,14 @@
* *
* if (cipher_encrypt(&cipher, plain_text, cipher_text) < 0) * if (cipher_encrypt(&cipher, plain_text, cipher_text) < 0)
* printf("Cipher encryption!\n"); * printf("Cipher encryption!\n");
* \endcode * @endcode
* *
* If you need to encrypt data of arbitrary size take a look at the different * If you need to encrypt data of arbitrary size take a look at the different
* operation modes like: CBC, CTR or CCM. * operation modes like: CBC, CTR or CCM.
* *
* Additional examples can be found in the test suite. * Additional examples can be found in the test suite.
* *
* \section hashes Hashes * @section hashes Hashes
* *
* RIOT currently supports sha256 as a cryptographic hash implementation. * RIOT currently supports sha256 as a cryptographic hash implementation.
*/ */