Documentation updates.

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

diff --git a/bertos/algo/tea.h b/bertos/algo/tea.h
index cbd189b19092f7d4ffc306843e17ba3cef5b811a..bf2144444715f137e54e145b913320f1bdc7a82f 100644 (file)
--- a/bertos/algo/tea.h
+++ b/bertos/algo/tea.h
@@ -33,7 +33,7 @@
  * \brief TEA Tiny Encription Algorith functions.
  *
  * Documentation for TEA is available at
  * \brief TEA Tiny Encription Algorith functions.
  *
  * Documentation for TEA is available at

- * http://www.cl.cam.ac.uk/ftp/users/djw3/tea.ps.
+ * http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm

  *
  * \author Francesco Sacchi <batt@develer.com>
  *
  *
  * \author Francesco Sacchi <batt@develer.com>
  *

diff --git a/bertos/sec/cipher.h b/bertos/sec/cipher.h
index 845a32d24a72b890eec5437f6299b6128cfbcfab..22eb313bdd27e3f08db35394962d786e1971f63d 100644 (file)
--- a/bertos/sec/cipher.h
+++ b/bertos/sec/cipher.h
@@ -196,7 +196,7 @@ void cipher_ctr_step(BlockCipher *c, void *block);
 /**
  * Initialize OFB by setting the IV.
  *
 /**
  * Initialize OFB by setting the IV.
  *

- * \note the memory pointed by \a iv will be used and modified by the CBC
+ * \note the memory pointed by \a iv will be used and modified by the OFB

  * functions. It is caller's responsibility to keep it available until there is
  * no more OFB work to do.
  */
  * functions. It is caller's responsibility to keep it available until there is
  * no more OFB work to do.
  */

diff --git a/bertos/struct/hashtable.h b/bertos/struct/hashtable.h
index 0b6f4c8f23816fa9b5f42ba6a676c5cde68b94d6..695be32772a6b2ff029796237477399aaef1b546 100644 (file)
--- a/bertos/struct/hashtable.h
+++ b/bertos/struct/hashtable.h
@@ -30,7 +30,9 @@
  * Copyright 2004 Giovanni Bajo
  * -->
  *
  * Copyright 2004 Giovanni Bajo
  * -->
  *

- * \author Giovanni Bajo <rasky@develer.com>
+ * \defgroup hashtable Hash table implementation
+ * \ingroup struct
+ * \{

  *
  * \brief Portable hash table
  *
  *
  * \brief Portable hash table
  *


@@ -50,6 +52,8 @@
  * a marker for a free node, so it is invalid to store a NULL pointer in the table
  * with \c ht_insert().
  *
  * a marker for a free node, so it is invalid to store a NULL pointer in the table
  * with \c ht_insert().
  *

+ * \author Giovanni Bajo <rasky@develer.com>
+ *

  * $WIZ$ module_name = "hashtable"
  * $WIZ$ module_configuration = "bertos/cfg/cfg_hashtable.h"
  */
  * $WIZ$ module_name = "hashtable"
  * $WIZ$ module_configuration = "bertos/cfg/cfg_hashtable.h"
  */


@@ -289,4 +293,6 @@ int hashtable_testSetup(void);
 int hashtable_testRun(void);
 int hashtable_testTearDown(void);
 
 int hashtable_testRun(void);
 int hashtable_testTearDown(void);
 

+/** \} */ // \defgroup hashtable
+

 #endif /* STRUCT_HASHTABLE_H */
 #endif /* STRUCT_HASHTABLE_H */

diff --git a/doc/general-introduction b/doc/general-introduction
index b7117affb5be8b15fc862faf2f062a4655f2e73b..93f3a597514cd41ec8719f5eea919a881e1b7c6e 100644 (file)
--- a/doc/general-introduction
+++ b/doc/general-introduction
@@ -12,7 +12,8 @@ BeRTOS uses object oriented programming concepts for the base interfaces.
 If used in the right way, OOP elegantly solves a broad range of problems
 linked with the creation of common and reusable interfaces that allow
 you to save development time and precious memory space.
 If used in the right way, OOP elegantly solves a broad range of problems
 linked with the creation of common and reusable interfaces that allow
 you to save development time and precious memory space.

-Have a look at <a href="">KFile tutorial</a> on BeRTOS web site for
+Have a look at <a href="http://www.bertos.org/use/tutorial-front-page/drivers-kfile-interface/">
+KFile tutorial</a> on BeRTOS web site for

 a more complete introduction to object oriented programming.
 
 <h2>OOP in C</h2>
 a more complete introduction to object oriented programming.
 
 <h2>OOP in C</h2>