From 3b9f400868fc382a5f61db4eb7105be999049c7b Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Fri, 9 Dec 2011 00:36:44 +0000
Subject: Improve documentation.

git-svn-id: http://svn.drobilla.net/lad/trunk/ganv@3840 a436a847-0d15-0410-975c-d299462d15a1
---
 ganv/canvas.h | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'ganv/canvas.h')

diff --git a/ganv/canvas.h b/ganv/canvas.h
index a011cff..0770d2a 100644
--- a/ganv/canvas.h
+++ b/ganv/canvas.h
@@ -16,6 +16,14 @@
 #ifndef GANV_CANVAS_H
 #define GANV_CANVAS_H
 
+/**
+ * SECTION:ganv
+ * 
+ * @version: 1.0.0
+ * @Version: 1.0.0
+ *
+ * #GanvCanvas is possibly the greatest thing, ever.
+ */
 #include <libgnomecanvas/libgnomecanvas.h>
 
 #include "ganv/types.h"
@@ -34,6 +42,14 @@ struct GanvCanvasImpl;
 
 typedef struct _GanvCanvasClass GanvCanvasClass;
 
+/**
+ * GanvDirection:
+ * @GANV_DIRECTION_DOWN: Signal flows from top to bottom.
+ * @GANV_DIRECTION_RIGHT: Signal flows from left to right.
+ *
+ * Specifies the direction of signal flow on the canvas, which affects the
+ * appearance of modules and how the canvas is auto-arranged.
+ */
 typedef enum {
 	GANV_DIRECTION_DOWN,
 	GANV_DIRECTION_RIGHT
@@ -85,6 +101,8 @@ typedef void (*GanvEdgeFunction)(GanvEdge* edge);
 
 /**
  * ganv_canvas_for_each_edge_from:
+ * @canvas: The canvas.
+ * @tail: The tail to enumerate every edge for.
  * @f: (scope call): A function to call on every edge leaving @tail.
  */
 void
@@ -94,6 +112,8 @@ ganv_canvas_for_each_edge_from(GanvCanvas*      canvas,
 
 /**
  * ganv_canvas_for_each_edge_to:
+ * @canvas: The canvas.
+ * @head: The head to enumerate every edge for.
  * @f: (scope call): A function to call on every edge entering @head.
  */
 void
@@ -103,6 +123,8 @@ ganv_canvas_for_each_edge_to(GanvCanvas*      canvas,
 
 /**
  * ganv_canvas_for_each_edge_on:
+ * @canvas: The canvas.
+ * @node: The node to enumerate every edge for.
  * @f: (scope call): A function to call on every edge attached to @node.
  */
 void
-- 
cgit v1.2.1