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

diff --git a/bertos/gfx/charts.h b/bertos/gfx/charts.h
index eb3eea0709d70ae7c5efd8f7aa88bc1df59f775e..e98f8cbc34301d32e1b2734253179e21d5a4253d 100644 (file)
--- 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 971c1298adfc1f33fa3d291c10bad117d12862db..5ac1dc240db1629ceb29db383d211f5848e3231a 100644 (file)
--- a/bertos/gfx/gfx.h
+++ b/bertos/gfx/gfx.h
@@ -30,6 +30,9 @@
  * Copyright 1999 Bernie Innocenti <bernie@codewiz.org>
  *
  *
+ * \defgroup gfx Graphics routines
+ * \ingroup graphics
+ * \{
  * \author Bernie Innocenti <bernie@codewiz.org>
  * \author Stefano Fedrigo <aleph@develer.com>
  *
@@ -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 e7ac8c771a2114cf133be33089bc8d98949149f6..aea4b1dd7fbd5a5470284e115a57bf6b6ac7a5ff 100644 (file)
--- 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 <bernie@codewiz.org>
@@ -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 b21b023f72aab7b50e87f7c106408b3240e79914..b3ada468f2b2cdbe3cc4ff5ed7f38d30e761a94b 100644 (file)
--- 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 <bernie@codewiz.org>
  * \author Stefano Fedrigo <aleph@develer.com>
  *
@@ -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 3e549ac7960dfe9fa5748caffa3a8608fdf67dc7..8d01d4accc8c9da07f2c4da45b350b0b378cc249 100644 (file)
--- 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
+ *
+ */