From 00df069cdf55e115ea734119c0ba97b78192cfcc Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Fri, 9 Dec 2011 01:16:44 +0000
Subject: Improve documentation and GIR bindings.

git-svn-id: http://svn.drobilla.net/lad/trunk/ganv@3841 a436a847-0d15-0410-975c-d299462d15a1
---
 ganv/canvas.h | 4 ++++
 ganv/edge.h   | 8 ++++++++
 ganv/module.h | 4 ++++
 ganv/node.h   | 4 ++++
 4 files changed, 20 insertions(+)

(limited to 'ganv')

diff --git a/ganv/canvas.h b/ganv/canvas.h
index 0770d2a..906f7c4 100644
--- a/ganv/canvas.h
+++ b/ganv/canvas.h
@@ -76,6 +76,10 @@ GanvCanvas* ganv_canvas_new(double width, double height);
 void
 ganv_canvas_resize(GanvCanvas* canvas, double width, double height);
 
+/**
+ * ganv_canvas_get_root:
+ * Return value: (transfer none): The root group of @canvas.
+ */
 GnomeCanvasGroup*
 ganv_canvas_get_root(const GanvCanvas* canvas);
 
diff --git a/ganv/edge.h b/ganv/edge.h
index 8e6c6cb..6fd2ffe 100644
--- a/ganv/edge.h
+++ b/ganv/edge.h
@@ -80,9 +80,17 @@ void
 ganv_edge_tick(GanvEdge* edge,
                double    seconds);
 
+/**
+ * ganv_edge_get_tail:
+ * Return value: (transfer none): The tail of @a edge.
+ */
 GanvNode*
 ganv_edge_get_tail(const GanvEdge* edge);
 
+/**
+ * ganv_edge_get_head:
+ * Return value: (transfer none): The head of @a edge.
+ */
 GanvNode*
 ganv_edge_get_head(const GanvEdge* edge);
 
diff --git a/ganv/module.h b/ganv/module.h
index f1c4f2c..718756b 100644
--- a/ganv/module.h
+++ b/ganv/module.h
@@ -54,6 +54,10 @@ ganv_module_new(GanvCanvas* canvas,
 guint
 ganv_module_num_ports(const GanvModule* module);
 
+/**
+ * ganv_module_get_port:
+ * Return value: (transfer none): The port on @module at @index.
+ */
 GanvPort*
 ganv_module_get_port(GanvModule* module,
                      guint       index);
diff --git a/ganv/node.h b/ganv/node.h
index 238492f..c814c8c 100644
--- a/ganv/node.h
+++ b/ganv/node.h
@@ -131,6 +131,10 @@ ganv_node_get_draw_properties(const GanvNode* node,
 
 const char* ganv_node_get_label(const GanvNode* node);
 
+/**
+ * ganv_node_get_partner:
+ * Return value: (transfer none): The partner of @node.
+ */
 GanvNode*
 ganv_node_get_partner(const GanvNode* node);
 
-- 
cgit v1.2.1