X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fgfx%2Fcharts.h;h=e98f8cbc34301d32e1b2734253179e21d5a4253d;hb=a5b1dc3c2884ee2160c6fee43e4a34b83453b87f;hp=ce4bd88328b1647a03915ae9e732484a00cf3ac3;hpb=791e167e053bdd9250d34a9a5ccae6ccde4d6679;p=bertos.git

diff --git a/bertos/gfx/charts.h b/bertos/gfx/charts.h
index ce4bd883..e98f8cbc 100644
--- a/bertos/gfx/charts.h
+++ b/bertos/gfx/charts.h
@@ -27,58 +27,39 @@
  * the GNU General Public License.
  *
  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
- * Copyright 1999, 2000, 2001, 2003 Bernardo Innocenti <bernie@develer.com>
+ * Copyright 1999, 2000, 2001, 2003 Bernie Innocenti <bernie@codewiz.org>
  *
  * -->
  *
+ * \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$
- * \author Bernardo Innocenti <bernie@develer.com>
+ * 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>
  */
 
-/*#*
- *#* $Log$
- *#* Revision 1.5  2006/08/01 12:23:03  bernie
- *#* Indentation fix.
- *#*
- *#* Revision 1.4  2006/07/19 12:56:26  bernie
- *#* Convert to new Doxygen style.
- *#*
- *#* Revision 1.3  2005/11/27 23:36:18  bernie
- *#* Use appconfig.h instead of cfg/config.h.
- *#*
- *#* Revision 1.2  2005/11/04 18:17:45  bernie
- *#* Fix header guards and includes for new location of gfx module.
- *#*
- *#* Revision 1.1  2005/11/04 18:11:35  bernie
- *#* Move graphics stuff from mware/ to gfx/.
- *#*
- *#* Revision 1.7  2005/11/04 16:20:02  bernie
- *#* Fix reference to README.devlib in header.
- *#*
- *#* Revision 1.6  2005/04/11 19:10:28  bernie
- *#* Include top-level headers from cfg/ subdir.
- *#*
- *#* Revision 1.5  2004/09/14 20:56:39  bernie
- *#* Make more generic and adapt to new gfx functions.
- *#*
- *#* Revision 1.3  2004/08/11 19:39:12  bernie
- *#* Use chart_x_t and chart_y_t for the input dataset.
- *#*
- *#* Revision 1.1  2004/08/04 03:16:30  bernie
- *#* Import simple chart drawing code.
- *#*
- *#*/
 #ifndef GFX_CHARTS_H
 #define GFX_CHARTS_H
 
+#include "cfg/cfg_gfx.h" /* CONFIG_ stuff */
+
 #include <gfx/gfx.h>   /* vcoord_t */
-#include <appconfig.h> /* CONFIG_ stuff */
 
 /**
  * \name Width/height of the small ticks drawn over the axes
@@ -117,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 */