summaryrefslogtreecommitdiffstats
path: root/ganv
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2013-03-25 00:32:29 +0000
committerDavid Robillard <d@drobilla.net>2013-03-25 00:32:29 +0000
commit4168f05087a7ab656bb027ad7334acd6bcb63d11 (patch)
tree78870a06d0a097825a2e51b575321f6e3ca113ed /ganv
parentffc2213e30454e6d02cd9ff02f961fee05f60065 (diff)
downloadganv-4168f05087a7ab656bb027ad7334acd6bcb63d11.tar.gz
ganv-4168f05087a7ab656bb027ad7334acd6bcb63d11.tar.bz2
ganv-4168f05087a7ab656bb027ad7334acd6bcb63d11.zip
Minor documentation improvements.
git-svn-id: http://svn.drobilla.net/lad/trunk/ganv@5099 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'ganv')
-rw-r--r--ganv/node.h18
1 files changed, 15 insertions, 3 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,