From f8224de0624cd0c81dbdf0bc969b86a83c29d5d8 Mon Sep 17 00:00:00 2001 From: lottaviano Date: Thu, 2 Jul 2009 13:12:51 +0000 Subject: [PATCH] doc: Various documentation updates. git-svn-id: https://src.develer.com/svnoss/bertos/trunk@2730 38d2e660-2303-0410-9eaa-f027e97ec537 --- STATUS | 18 +++++++++--------- bertos/algo/crc.h | 2 +- bertos/cfg/test.h | 2 ++ bertos/fs/fat.h | 4 ++++ bertos/gfx/bitmap.c | 1 + bertos/gfx/charts.c | 11 ----------- bertos/gfx/charts.h | 11 +++++++++++ bertos/gfx/line.c | 1 + 8 files changed, 29 insertions(+), 21 deletions(-) diff --git a/STATUS b/STATUS index 9bafa3bd..54733458 100644 --- 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: - + - - - + + +
Algorithm Status
\link crc.c CRC16 \endlink stable
\link crc.h CRC16 \endlink stable
\link md2.c MD2 \endlink beta
\link randpool.c Cryptographically secure Random Pool \endlink beta
\link rotating_hash.h Rotating hash checksum \endlink stable
\link tea.c TEA (Tiny Encryption Algorithm) \endlink stable
\link ramp.c Stepper motor ramp generator \endlink beta
\link pid_control.c PID Controller \endlink stable
\link tea.h TEA (Tiny Encryption Algorithm) \endlink stable
\link ramp.h Stepper motor ramp generator \endlink beta
\link pid_control.h PID Controller \endlink stable
\link rle.c RLE (Run lenght en/decondig) \endlink stable
@@ -252,11 +252,11 @@ This system is composed of several modules ranging from simple graphic primitive \link bitmap.c Bitmaps manipulation \endlink stable \link line.c Lines drawing \endlink stable \link line.c Rectangles drawing \endlink stable - \link win.c Simple windowing system \endlink stable + \link win.h Simple windowing system \endlink stable Proportional and fixed size fonts stable - \link text.c Text rendering \endlink stable - \link charts.c Simple Charts \endlink stable - \link menu.c Menus \endlink stable + \link text.h Text rendering \endlink stable + \link charts.h Simple Charts \endlink stable + \link menu.h Menus \endlink stable To get up to date informations look at the source code in the directories \b gfx, \b gui or \b fonts. @@ -278,7 +278,7 @@ For more information take a look at FatFs 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 fs directory. diff --git a/bertos/algo/crc.h b/bertos/algo/crc.h index be8f0df8..483f2192 100644 --- 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 f9c6ec21..aacf7e15 100644 --- 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 d0da925d..34b20bba 100644 --- 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 1cc13aea..c94306a9 100644 --- a/bertos/gfx/bitmap.c +++ b/bertos/gfx/bitmap.c @@ -35,6 +35,7 @@ * \author Stefano Fedrigo * * \brief Bitmap manipulation routines. + * \sa gfx.h */ #include "gfx.h" diff --git a/bertos/gfx/charts.c b/bertos/gfx/charts.c index 0a9a195d..718d0b78 100644 --- 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 735f8b7f..8b4e3458 100644 --- 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 */ diff --git a/bertos/gfx/line.c b/bertos/gfx/line.c index c9bb4695..4d756fe6 100644 --- a/bertos/gfx/line.c +++ b/bertos/gfx/line.c @@ -37,6 +37,7 @@ * \author Stefano Fedrigo * * \brief Line drawing graphics routines + * \sa gfx.h */ #include "gfx.h" -- 2.25.1