From 52dc681d37e2d83df0ab5450584c7591e219a8d6 Mon Sep 17 00:00:00 2001 From: lottaviano Date: Sun, 28 Nov 2010 16:49:32 +0000 Subject: [PATCH 1/1] doc: Add menu, gfx and text documentation into global index. git-svn-id: https://src.develer.com/svnoss/bertos/trunk@4584 38d2e660-2303-0410-9eaa-f027e97ec537 --- bertos/gfx/charts.h | 4 ++++ bertos/gfx/gfx.h | 4 ++++ bertos/gfx/text.h | 4 ++++ bertos/gui/menu.h | 4 ++++ doc/general-introduction | 10 ++++++++++ 5 files changed, 26 insertions(+) diff --git a/bertos/gfx/charts.h b/bertos/gfx/charts.h index eb3eea07..e98f8cbc 100644 --- a/bertos/gfx/charts.h +++ b/bertos/gfx/charts.h @@ -31,6 +31,9 @@ * * --> * + * \defgroup chart Chart graphical routines + * \ingroup graphics + * \{ * \brief Simple charts on top of mware/gfx routines (interface). * * Configuration: @@ -95,4 +98,5 @@ void chart_drawAxis(Bitmap *bm); void chart_drawCurve(Bitmap *bm, const chart_y_t *curve_y, int curve_cnt); void chart_drawDots(Bitmap *bm, const chart_x_t *dots_x, const chart_y_t *dots_y, int cnt); +/** \} */ //defgroup charts #endif /* GFX_CHARTS_H */ diff --git a/bertos/gfx/gfx.h b/bertos/gfx/gfx.h index 971c1298..5ac1dc24 100644 --- a/bertos/gfx/gfx.h +++ b/bertos/gfx/gfx.h @@ -30,6 +30,9 @@ * Copyright 1999 Bernie Innocenti * * + * \defgroup gfx Graphics routines + * \ingroup graphics + * \{ * \author Bernie Innocenti * \author Stefano Fedrigo * @@ -234,4 +237,5 @@ void gfx_vline(Bitmap *bm, vcoord_t x1, vcoord_t y1, vcoord_t x2, vcoord_t y2); EXTERN_C_END +/** \} */ //defgroup gfx #endif /* GFX_GFX_H */ diff --git a/bertos/gfx/text.h b/bertos/gfx/text.h index e7ac8c77..aea4b1dd 100644 --- a/bertos/gfx/text.h +++ b/bertos/gfx/text.h @@ -31,6 +31,9 @@ * * --> * + * \defgroup text Text handling on graphical displays. + * \ingroup graphics + * \{ * \brief Text graphic routines (interface) * * \author Bernie Innocenti @@ -119,4 +122,5 @@ int text_vwidthf_P(struct Bitmap *bm, const char * PROGMEM fmt, va_list ap); int text_widthf_P(struct Bitmap *bm, const char * PROGMEM fmt, ...); #endif /* CPU_HARVARD */ +/** \} */ //defgroup text #endif /* GFX_TEXT_H */ diff --git a/bertos/gui/menu.h b/bertos/gui/menu.h index b21b023f..b3ada468 100644 --- a/bertos/gui/menu.h +++ b/bertos/gui/menu.h @@ -31,6 +31,9 @@ * All Rights Reserved. * --> * + * \defgroup menu Menu handling module + * \ingroup gui + * \{ * \author Bernie Innocenti * \author Stefano Fedrigo * @@ -128,4 +131,5 @@ iptr_t menu_handle(const struct Menu *menu); int menu_setFlags(struct Menu *menu, int idx, int flags); int menu_clearFlags(struct Menu *menu, int idx, int flags); +/** \} */ //defgroup menu #endif /* GUI_MENU_H */ diff --git a/doc/general-introduction b/doc/general-introduction index 3e549ac7..8d01d4ac 100644 --- a/doc/general-introduction +++ b/doc/general-introduction @@ -91,3 +91,13 @@ int main() * This section describes various algorithms and standalone code * useful in day to day programming. */ + +/*! + * \defgroup graphics General purpose graphical routines + * + */ + +/*! + * \defgroup gui BeRTOS GUI toolkit + * + */ -- 2.25.1