aboutsummaryrefslogtreecommitdiffstats
path: root/include/graph.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/graph.h')
-rw-r--r--include/graph.h19
1 files changed, 18 insertions, 1 deletions
diff --git a/include/graph.h b/include/graph.h
index 9b4603bd..bc0d3d15 100644
--- a/include/graph.h
+++ b/include/graph.h
@@ -18,6 +18,14 @@
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+/**
+ * @file include/graph.h
+ * @brief GRAPH module header file.
+ *
+ * @addtogroup GRAPH
+ * @{
+ */
+
#ifndef GRAPH_H
#define GRAPH_H
@@ -25,7 +33,11 @@
#define GFX_USE_GRAPH FALSE
#endif
-#if GFX_USE_GRAPH
+#if GFX_USE_GRAPH || defined(__DOXYGEN__)
+
+/*===========================================================================*/
+/* Type definitions */
+/*===========================================================================*/
typedef struct _Graph {
coord_t origin_x;
@@ -52,6 +64,10 @@ typedef struct _Graph {
extern "C" {
#endif
+/*===========================================================================*/
+/* Type definitions */
+/*===========================================================================*/
+
void graphDrawSystem(Graph *g);
void graphDrawDot(Graph *g, coord_t x, coord_t y, uint16_t radius, color_t color);
void graphDrawDots(Graph *g, int coord[][2], uint16_t entries, uint16_t radius, uint16_t color);
@@ -64,4 +80,5 @@ void graphDrawNet(Graph *g, int coord[][2], uint16_t entries, uint16_t radius, u
#endif /* GFX_USE_GRAPH */
#endif
+/** @} */