doc: Add menu, gfx and text documentation into global index.

[bertos.git] / bertos / gfx / charts.h

diff --git a/bertos/gfx/charts.h b/bertos/gfx/charts.h
index 735f8b7fb7c7007a88ff29ba1142401bef6e83de..e98f8cbc34301d32e1b2734253179e21d5a4253d 100644 (file)
--- a/bertos/gfx/charts.h
+++ b/bertos/gfx/charts.h
@@ -31,13 +31,26 @@
  *
  * -->
  *
+ * \defgroup chart Chart graphical routines
+ * \ingroup graphics
+ * \{
  * \brief Simple charts on top of mware/gfx routines (interface).
  *
  * Configuration:
  *  - \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
  *
- * \version $Id$
+ * 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
  * \author Bernie Innocenti <bernie@codewiz.org>
  */
 
@@ -85,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 */