Skip to content

Commit

Permalink
doc: minor fixing for crypto module
Browse files Browse the repository at this point in the history
Moves the crypto module documentation to the right group and streamline the doxygen keywords.
  • Loading branch information
OlegHahm committed Aug 26, 2015
1 parent aa0e990 commit 4a8e897
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions sys/crypto/doc.txt
Expand Up @@ -8,10 +8,12 @@

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

0 comments on commit 4a8e897

Please sign in to comment.