From 4168f05087a7ab656bb027ad7334acd6bcb63d11 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Mon, 25 Mar 2013 00:32:29 +0000
Subject: Minor documentation improvements.

git-svn-id: http://svn.drobilla.net/lad/trunk/ganv@5099 a436a847-0d15-0410-975c-d299462d15a1
---
 ganv/node.h | 18 +++++++++++++++---
 src/node.c  | 11 +++++------
 2 files changed, 20 insertions(+), 9 deletions(-)

diff --git a/ganv/node.h b/ganv/node.h
index 47e27b1..dd51cc2 100644
--- a/ganv/node.h
+++ b/ganv/node.h
@@ -80,14 +80,26 @@ struct _GanvNodeClass {
 
 GType ganv_node_get_type(void);
 
+/**
+ * ganv_node_can_tail:
+ * Return value: True iff node can act as the tail of an edge.
+ */
 gboolean
-ganv_node_can_tail(const GanvNode* self);
+ganv_node_can_tail(const GanvNode* node);
 
+/**
+ * ganv_node_can_head:
+ * Return value: True iff node can act as the head of an edge.
+ */
 gboolean
-ganv_node_can_head(const GanvNode* self);
+ganv_node_can_head(const GanvNode* node);
 
+/**
+ * ganv_node_is_within:
+ * Return value: True iff node is entirely within the given rectangle.
+ */
 gboolean
-ganv_node_is_within(const GanvNode* self,
+ganv_node_is_within(const GanvNode* node,
                     double          x1,
                     double          y1,
                     double          x2,
diff --git a/src/node.c b/src/node.c
index 511b1f3..b6d431c 100644
--- a/src/node.c
+++ b/src/node.c
@@ -691,23 +691,22 @@ ganv_node_can_head(const GanvNode* self)
 }
 
 gboolean
-ganv_node_is_within(const GanvNode* self,
+ganv_node_is_within(const GanvNode* node,
                     double          x1,
                     double          y1,
                     double          x2,
                     double          y2)
 {
-	return GANV_NODE_GET_CLASS(self)->is_within(
-		self, x1, y1, x2, y2);
+	return GANV_NODE_GET_CLASS(node)->is_within(node, x1, y1, x2, y2);
 }
 
 void
-ganv_node_tick(GanvNode* self,
+ganv_node_tick(GanvNode* node,
                double    seconds)
 {
-	GanvNodeClass* klass = GANV_NODE_GET_CLASS(self);
+	GanvNodeClass* klass = GANV_NODE_GET_CLASS(node);
 	if (klass->tick) {
-		klass->tick(self, seconds);
+		klass->tick(node, seconds);
 	}
 }
 
-- 
cgit v1.2.1