Fix some doxygen errors.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@799 38d2e660-2303-0410-9eaa-f027e97ec537

diff --git a/algos/md2.c b/algos/md2.c
index fa310b4605b9cfc72d98a927c8c85a8eb33b8625..8b5b97c5bc23695dfb012566fc4ea4e919445bd8 100755 (executable)
--- a/algos/md2.c
+++ b/algos/md2.c
@@ -8,12 +8,12 @@
  * \brief MD2 Message-Digest algorithm.
  *
  * The MD2 algorithm work with a constant array of 256 permutationt
- * defined in RFC1319. If you don't want to use a standard array of 
- * permutatione you can use a md2_perm() function that generate an 
- * array of 256 "casual" permutation. To swich from a standard array 
- * to md2_perm function you must chanche CONFIG_MD2_STD_PERM defined in 
+ * defined in RFC1319. If you don't want to use a standard array of
+ * permutatione you can use a md2_perm() function that generate an
+ * array of 256 "casual" permutation. To swich from a standard array
+ * to md2_perm function you must chanche CONFIG_MD2_STD_PERM defined in
  * appconfig.h.
- * If you need to store array in program memory you must define 
+ * If you need to store array in program memory you must define
  * a macro _PROGMEM (for more info see mware/pgm.h).
  *
  *
@@ -23,6 +23,9 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.17  2007/06/07 16:06:39  batt
+ *#* Fix some doxygen errors.
+ *#*
  *#* Revision 1.16  2007/02/15 13:29:49  asterix
  *#* Add MD2_DIGEST_LEN macro.
  *#*
@@ -64,7 +67,7 @@
 #include <cfg/compiler.h>
 #include <cfg/debug.h>        //ASSERT()
 #include <cfg/macros.h>       //MIN(), countof(), ROTR();
-#include <mware/pgm.h>   
+#include <mware/pgm.h>
 
 
 #if CONFIG_MD2_STD_PERM
@@ -72,7 +75,7 @@
        * Official array of 256 byte pemutation contructed from digits of pi, defined
        * in the RFC 1319.
        */
-       static const uint8_t PGM_ATTR md2_perm[256] = 
+       static const uint8_t PGM_ATTR md2_perm[256] =
        {
        41, 46, 67, 201, 162, 216, 124, 1, 61, 54, 84, 161, 236, 240, 6,
        19, 98, 167, 5, 243, 192, 199, 115, 140, 152, 147, 43, 217, 188,
@@ -99,7 +102,7 @@
        /**
         * Md2_perm() function generate an array of 256 "casual" permutation.
         */
-       
+
        /**
         * Costant define for computing an array of 256 "casual" permutation.
         * \{
@@ -122,7 +125,7 @@
        }
 
        #define MD2_PERM(x) md2_perm(x)
-               
+
 #endif
 
 
@@ -204,7 +207,7 @@ static void md2_compute(void *_state, void *_checksum, void *_block)
 /**
  * Algorithm initialization.
  *
- * \param empty context.
+ * \param context empty context.
  */
 void md2_init(Md2Context *context)
 {
@@ -232,14 +235,14 @@ void md2_update(Md2Context *context, const void *_block_in, size_t block_len)
                 */
                cpy_len = MIN(block_len, CONFIG_MD2_BLOCK_LEN - context->counter);
 
-               
+
                /*
                 * Copy in the buffer input block.
                 */
                memcpy(&context->buffer[context->counter], block_in, cpy_len);
 
                /*
-                * Update a context counter, input block length and remaning 
+                * Update a context counter, input block length and remaning
                 * context buffer block lenght.
                 */
                context->counter += cpy_len;

diff --git a/algos/randpool.c b/algos/randpool.c
index 3bb64770f51856d74c4efae8459fd55e9d8dd047..735bd06e9447007a110a795eaf5a386713705b6e 100755 (executable)
--- a/algos/randpool.c
+++ b/algos/randpool.c
@@ -13,6 +13,9 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.20  2007/06/07 16:06:39  batt
+ *#* Fix some doxygen errors.
+ *#*
  *#* Revision 1.19  2007/02/15 13:54:26  asterix
  *#* Rename randpool_getN in randpool_get. Fix bug in randpool_get.
  *#*
@@ -124,7 +127,7 @@ static void randpool_stir(EntropyPool *pool)
 }
 
 /**
- * Add \param entropy bits from \param data buffer to the entropy \param pool.
+ * Add \param entropy bits from \param data buffer to the entropy \param pool
  */
 void randpool_add(EntropyPool *pool, void *data, size_t entropy)
 {
@@ -207,6 +210,9 @@ size_t randpool_size(EntropyPool *pool)
  * byte of entropy in entropy pool, randpool_get continue
  * to generate pseudocasual value from previous state of
  * pool.
+ * \param n_byte number fo bytes to read.
+ * \param pool is the pool entropy context.
+ * \param _data is the pointer to write the random data to.
  */
 void randpool_get(EntropyPool *pool, void *_data, size_t n_byte)
 {
@@ -222,7 +228,7 @@ void randpool_get(EntropyPool *pool, void *_data, size_t n_byte)
        /* Test if i + CONFIG_MD2_BLOCK_LEN  is inside of entropy pool.*/
        ASSERT((MD2_DIGEST_LEN + i) < CONFIG_SIZE_ENTROPY_POOL);
 
-       md2_init(&context); 
+       md2_init(&context);
 
        while(n > 0)
        {
@@ -247,10 +253,8 @@ void randpool_get(EntropyPool *pool, void *_data, size_t n_byte)
                }
 
        }
-       
 
        pool->pos_get = i; //Current number of byte we get from pool.
-       
        pool->entropy -= n_byte; //Update a entropy.
 
        /*If we get all entropy entropy is 0*/