From: lottaviano Date: Tue, 17 May 2011 09:59:17 +0000 (+0000) Subject: Documentation updates. X-Git-Tag: 2.7.0~62 X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=8a26e7a027c43bc89393a5742aed8d703edff0a0;p=bertos.git 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 cbd189b1..bf214444 100644 --- 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 - * http://www.cl.cam.ac.uk/ftp/users/djw3/tea.ps. + * http://en.wikipedia.org/wiki/Tiny_Encryption_Algorithm * * \author Francesco Sacchi * diff --git a/bertos/sec/cipher.h b/bertos/sec/cipher.h index 845a32d2..22eb313b 100644 --- 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. * - * \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. */ diff --git a/bertos/struct/hashtable.h b/bertos/struct/hashtable.h index 0b6f4c8f..695be327 100644 --- a/bertos/struct/hashtable.h +++ b/bertos/struct/hashtable.h @@ -30,7 +30,9 @@ * Copyright 2004 Giovanni Bajo * --> * - * \author Giovanni Bajo + * \defgroup hashtable Hash table implementation + * \ingroup struct + * \{ * * \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(). * + * \author Giovanni Bajo + * * $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); +/** \} */ // \defgroup hashtable + #endif /* STRUCT_HASHTABLE_H */ diff --git a/doc/general-introduction b/doc/general-introduction index b7117aff..93f3a597 100644 --- 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. -Have a look at KFile tutorial on BeRTOS web site for +Have a look at +KFile tutorial on BeRTOS web site for a more complete introduction to object oriented programming.

OOP in C