* 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>
*/
#ifndef GFX_CHARTS_H
#define GFX_CHARTS_H
-#include <cfg/cfg_gfx.h> /* CONFIG_ stuff */
+#include "cfg/cfg_gfx.h" /* CONFIG_ stuff */
#include <gfx/gfx.h> /* vcoord_t */
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 */