doc: Various documentation updates.

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

diff --git a/STATUS b/STATUS
index 9bafa3bd9a7e87afc666db6ef2c4e5318f3e8d75..54733458c0f85d1f0d3fdd7bd9d40ed93c7a9d50 100644 (file)
--- a/STATUS
+++ b/STATUS
@@ -231,13 +231,13 @@ In embedded programming sometimes you have to cope with protocols, security syst
 BeRTOS comes in help with a set of optimized portable algorithms:
 <table>
 <tr> <td> <b> Algorithm </b> </td> <td> <b> Status </b> </td> </tr>
-<tr> <td> \link crc.c CRC16 \endlink</td>  <td>stable</td> </tr>
+<tr> <td> \link crc.h CRC16 \endlink</td>  <td>stable</td> </tr>
 <tr> <td> \link md2.c MD2 \endlink</td>  <td>beta</td> </tr>
 <tr> <td> \link randpool.c Cryptographically secure Random Pool \endlink</td>  <td>beta</td> </tr>
 <tr> <td> \link rotating_hash.h Rotating hash checksum \endlink</td>  <td>stable</td> </tr>
-<tr> <td> \link tea.c TEA (Tiny Encryption Algorithm) \endlink</td>  <td>stable</td> </tr>
-<tr> <td> \link ramp.c Stepper motor ramp generator \endlink</td>  <td>beta</td> </tr>
-<tr> <td> \link pid_control.c PID Controller \endlink</td>  <td>stable</td> </tr>
+<tr> <td> \link tea.h TEA (Tiny Encryption Algorithm) \endlink</td>  <td>stable</td> </tr>
+<tr> <td> \link ramp.h Stepper motor ramp generator \endlink</td>  <td>beta</td> </tr>
+<tr> <td> \link pid_control.h PID Controller \endlink</td>  <td>stable</td> </tr>
 <tr> <td> \link rle.c RLE (Run lenght en/decondig) \endlink</td>  <td>stable</td> </tr>
 </table>
 
@@ -252,11 +252,11 @@ This system is composed of several modules ranging from simple graphic primitive
 <tr> <td> \link bitmap.c Bitmaps manipulation \endlink</td>  <td>stable</td> </tr>
 <tr> <td> \link line.c Lines drawing \endlink</td>  <td>stable</td> </tr>
 <tr> <td> \link line.c Rectangles drawing \endlink</td>  <td>stable</td> </tr>
-<tr> <td> \link win.c Simple windowing system \endlink</td>  <td>stable</td> </tr>
+<tr> <td> \link win.h Simple windowing system \endlink</td>  <td>stable</td> </tr>
 <tr> <td> Proportional and fixed size fonts</td>  <td>stable</td> </tr>
-<tr> <td> \link text.c Text rendering \endlink</td>  <td>stable</td> </tr>
-<tr> <td> \link charts.c Simple Charts \endlink</td>  <td>stable</td> </tr>
-<tr> <td> \link menu.c Menus \endlink</td>  <td>stable</td> </tr>
+<tr> <td> \link text.h Text rendering \endlink</td>  <td>stable</td> </tr>
+<tr> <td> \link charts.h Simple Charts \endlink</td>  <td>stable</td> </tr>
+<tr> <td> \link menu.h Menus \endlink</td>  <td>stable</td> </tr>
 </table>
 
 To get up to date informations look at <A href="http://dev.bertos.org/browser/trunk/bertos/">the source code</A> in the directories \b gfx, \b gui or \b fonts.
@@ -278,7 +278,7 @@ For more information take a look at <A href="http://dev.bertos.org/browser/trunk
 \section fs File system 
 The latest SVN version of BeRTOS supports \link fat.h FAT \endlink filesystems using the <A href="http://elm-chan.org/fsw/ff/00index_e.html">FatFs</A>  library. The module is highly configurable, for example it can be compiled in read-only mode for some space saving.
 
-\link battfs.c BattFs\endlink, a file system specifically planned for embedded platforms, is in the beta stage. The goal is to have a filesystem suitable for little flash and eeprom memories (like dataflash), reliable, robust and capable of wear-levelling the memory pages to increase its life.
+\link battfs.h BattFs\endlink, a file system specifically planned for embedded platforms, is in the beta stage. The goal is to have a filesystem suitable for little flash and eeprom memories (like dataflash), reliable, robust and capable of wear-levelling the memory pages to increase its life.
 Currently you can create files, append data to them but file deletion is still not supported. Wear-levelling is achieved by rotating a page every time it is written. Plans are to add even transactions (a whole write can be performed atomically).
 
 File system development takes place in the <A href="http://dev.bertos.org/browser/trunk/bertos/fs">fs directory</A>.

diff --git a/bertos/algo/crc.h b/bertos/algo/crc.h
index be8f0df8be16915f3318852f3329f2bda9e70fc1..483f2192cf29916ba0e366ab604286b5c3e0d2a3 100644 (file)
--- a/bertos/algo/crc.h
+++ b/bertos/algo/crc.h
@@ -77,7 +77,7 @@ extern const uint16_t crc16tab[256];
 
 #ifdef INLINE
 /**
- * \brief Compute the updated CRC16 value for one octet (macro version)
+ * \brief Compute the updated CRC16 value for one octet (inline version)
  */
 INLINE uint16_t updcrc16(uint8_t c, uint16_t oldcrc)
 {

diff --git a/bertos/cfg/test.h b/bertos/cfg/test.h
index f9c6ec21d4edf0562b4352de054ce118f3f59208..aacf7e15341b43226b865d74f785ac26aa552c9a 100644 (file)
--- a/bertos/cfg/test.h
+++ b/bertos/cfg/test.h
@@ -41,9 +41,11 @@
  * platforms, these macros come in handy.
  * Your module_test should supply three basic functions:
  *
+ * \code
  * int module_testSetup(void)
  * int module_testRun(void)
  * int module_testTearDown(void)
+ * \endcode
  *
  * All of these should return 0 if ok or a value != 0 on errors.
  *

diff --git a/bertos/fs/fat.h b/bertos/fs/fat.h
index d0da925d75ce113595837ea92513bd0592b2db89..34b20bbac1a7e2725fd562264984857384509ae0 100644 (file)
--- a/bertos/fs/fat.h
+++ b/bertos/fs/fat.h
@@ -65,6 +65,10 @@ INLINE FatFile * FATFILE_CAST(KFile *fd)
 
 /**
  * Initialize \a file and open \a file_path for reading.
+ * \param file A pointer to a FatFile structure.
+ * \param file_path The file path on the filesystem.
+ * \param mode Open mode for the file.
+ * \sa ff.h for return code meaning and \a mode flags.
  */
 FRESULT fatfile_open(FatFile *file, const char *file_path, BYTE mode);
 

diff --git a/bertos/gfx/bitmap.c b/bertos/gfx/bitmap.c
index 1cc13aea7b0292f24d689235107989cd664a40c9..c94306a9a0e939d128ed5d6d27b5d9e5dc721e75 100644 (file)
--- a/bertos/gfx/bitmap.c
+++ b/bertos/gfx/bitmap.c
@@ -35,6 +35,7 @@
  * \author Stefano Fedrigo <aleph@develer.com>
  *
  * \brief Bitmap manipulation routines.
+ * \sa gfx.h
  */
 
 #include "gfx.h"

diff --git a/bertos/gfx/charts.c b/bertos/gfx/charts.c
index 0a9a195db1dfad8d2c9ceec5bca8aef9f8745ca9..718d0b782200ac335e53faf63177e38403049a67 100644 (file)
--- a/bertos/gfx/charts.c
+++ b/bertos/gfx/charts.c
@@ -36,17 +36,6 @@
  *
  * \brief Simple charts on top of mware/gfx routines (implementation).
  *
- * Sample usage:
- *
- * \code
- *     bm = chart_init(0, ymax, N_POINTS_CURVE, ymin);
- *
- *     chart_drawCurve(bm, curve_y, curve_points + 1);
- *     gfx_setViewRect(bm, xmin, ymax, xmax, ymin);
- *     chart_drawDots(bm, samples_x, samples_y, samples_cnt);
- *
- *     print_bitmap(bm);
- * \endcode
  */
 
 #include "charts.h"

diff --git a/bertos/gfx/charts.h b/bertos/gfx/charts.h
index 735f8b7fb7c7007a88ff29ba1142401bef6e83de..8b4e345849b522fd186be3dd76da1ab392b86305 100644 (file)
--- a/bertos/gfx/charts.h
+++ b/bertos/gfx/charts.h
@@ -37,6 +37,17 @@
  *  - \c CONFIG_CHART_TYPE_X: type for the input dataset of X-coordinates
  *  - \c CONFIG_CHART_TYPE_Y: type for the input dataset of Y-coordinates
  *
+ * Sample usage:
+ *
+ * \code
+ *     bm = chart_init(0, ymax, N_POINTS_CURVE, ymin);
+ *
+ *     chart_drawCurve(bm, curve_y, curve_points + 1);
+ *     gfx_setViewRect(bm, xmin, ymax, xmax, ymin);
+ *     chart_drawDots(bm, samples_x, samples_y, samples_cnt);
+ *
+ *     print_bitmap(bm);
+ * \endcode
  * \version $Id$
  * \author Bernie Innocenti <bernie@codewiz.org>
  */

diff --git a/bertos/gfx/line.c b/bertos/gfx/line.c
index c9bb46952a4f528d3cc171fbac2f19e5571735b5..4d756fe68f34c709fe33d2fa8fa3eedd0db002d1 100644 (file)
--- a/bertos/gfx/line.c
+++ b/bertos/gfx/line.c
@@ -37,6 +37,7 @@
  * \author Stefano Fedrigo <aleph@develer.com>
  *
  * \brief Line drawing graphics routines
+ * \sa gfx.h
  */
 
 #include "gfx.h"