diff options
Diffstat (limited to 'ganv')
-rw-r--r-- | ganv/canvas.h | 4 | ||||
-rw-r--r-- | ganv/edge.h | 2 | ||||
-rw-r--r-- | ganv/module.h | 2 | ||||
-rw-r--r-- | ganv/node.h | 4 |
4 files changed, 12 insertions, 0 deletions
diff --git a/ganv/canvas.h b/ganv/canvas.h index cda7c1a..6d946f4 100644 --- a/ganv/canvas.h +++ b/ganv/canvas.h @@ -72,6 +72,7 @@ ganv_canvas_resize(GanvCanvas* canvas, double width, double height); /** * ganv_canvas_get_root: + * * Return value: (transfer none): The root group of @canvas. */ GanvItem* @@ -88,6 +89,7 @@ ganv_canvas_remove_node(GanvCanvas* canvas, /** * ganv_canvas_get_edge: * Get the edge between two nodes, or NULL if none exists. + * * Return value: (transfer none): The root group of @canvas. */ GanvEdge* @@ -122,6 +124,7 @@ void ganv_canvas_export_dot(GanvCanvas* canvas, const char* filename); /** + * GanvEdgeFunc: * A node function that takes a user data argument (for callbacks). * * Note that in the Gtk world it is considered safe to cast a function to a @@ -131,6 +134,7 @@ ganv_canvas_export_dot(GanvCanvas* canvas, const char* filename); typedef void (*GanvEdgeFunc)(GanvEdge* edge, void* data); /** + * GanvNodeFunc: * A node function that takes a user data argument (for callbacks). * * Note that in the Gtk world it is considered safe to cast a function to a diff --git a/ganv/edge.h b/ganv/edge.h index 8f1ee80..4c2248a 100644 --- a/ganv/edge.h +++ b/ganv/edge.h @@ -94,6 +94,7 @@ ganv_edge_tick(GanvEdge* edge, /** * ganv_edge_get_tail: + * * Return value: (transfer none): The tail of @a edge. */ GanvNode* @@ -101,6 +102,7 @@ ganv_edge_get_tail(const GanvEdge* edge); /** * ganv_edge_get_head: + * * Return value: (transfer none): The head of @a edge. */ GanvNode* diff --git a/ganv/module.h b/ganv/module.h index 31b76b1..2e350a6 100644 --- a/ganv/module.h +++ b/ganv/module.h @@ -55,6 +55,8 @@ ganv_module_num_ports(const GanvModule* module); /** * ganv_module_get_port: + * Get a port by index. + * * Return value: (transfer none): The port on @module at @index. */ GanvPort* diff --git a/ganv/node.h b/ganv/node.h index dd51cc2..c17dc60 100644 --- a/ganv/node.h +++ b/ganv/node.h @@ -82,6 +82,7 @@ GType ganv_node_get_type(void); /** * ganv_node_can_tail: + * * Return value: True iff node can act as the tail of an edge. */ gboolean @@ -89,6 +90,7 @@ 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 @@ -96,6 +98,7 @@ ganv_node_can_head(const GanvNode* node); /** * ganv_node_is_within: + * * Return value: True iff node is entirely within the given rectangle. */ gboolean @@ -146,6 +149,7 @@ double ganv_node_get_dash_length(const GanvNode* node); /** * ganv_node_get_partner: + * * Return value: (transfer none): The partner of @node. */ GanvNode* |