summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2014-04-27 23:43:59 +0000
committerDavid Robillard <d@drobilla.net>2014-04-27 23:43:59 +0000
commitbb0f1a087aa5079c448166fc6a5a1984bcd31319 (patch)
treeb95a71a26b1e085494929302682e9b265abc433e
parent177ef9fea33e2f8904cd6d06ec4404bfb60ed7f5 (diff)
downloadganv-bb0f1a087aa5079c448166fc6a5a1984bcd31319.tar.gz
ganv-bb0f1a087aa5079c448166fc6a5a1984bcd31319.tar.bz2
ganv-bb0f1a087aa5079c448166fc6a5a1984bcd31319.zip
Fix gtk-doc comment format.
git-svn-id: http://svn.drobilla.net/lad/trunk/ganv@5380 a436a847-0d15-0410-975c-d299462d15a1
-rw-r--r--ganv/box.h1
-rw-r--r--ganv/canvas.h18
-rw-r--r--ganv/edge.h2
-rw-r--r--ganv/module.h1
-rwxr-xr-xgtkdoc.sh2
-rw-r--r--src/Canvas.cpp4
6 files changed, 24 insertions, 4 deletions
diff --git a/ganv/box.h b/ganv/box.h
index 2fb6830..cf80001 100644
--- a/ganv/box.h
+++ b/ganv/box.h
@@ -37,6 +37,7 @@ struct _GanvBox {
/**
* GanvBoxClass:
+ * @parent_class: Node superclass.
* @set_width: Set the width of the box.
* @set_height: Set the height of the box.
*/
diff --git a/ganv/canvas.h b/ganv/canvas.h
index 02219c1..83e3f8a 100644
--- a/ganv/canvas.h
+++ b/ganv/canvas.h
@@ -67,6 +67,9 @@ GType ganv_canvas_get_type(void) G_GNUC_CONST;
/**
* GanvEdgeFunc:
+ * @edge: Canvas edge.
+ * @data: User callback data.
+ *
* 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
@@ -77,6 +80,9 @@ typedef void (*GanvEdgeFunc)(GanvEdge* edge, void* data);
/**
* GanvNodeFunc:
+ * @node: Canvas node.
+ * @data: User callback data.
+ *
* 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
@@ -95,6 +101,7 @@ ganv_canvas_new(double width, double height);
/**
* ganv_canvas_clear:
+ *
* Remove all items from the canvas.
*/
void
@@ -110,6 +117,7 @@ ganv_canvas_empty(const GanvCanvas* canvas);
/**
* ganv_canvas_resize:
+ *
* Resize the canvas to the given dimensions.
*/
void
@@ -241,7 +249,7 @@ ganv_canvas_w2c(GanvCanvas* canvas, double wx, double wy, int* cx, int* cy);
* @cy: Y pixel coordinate (return value).
*
* Converts world coordinates into canvas pixel coordinates. This version
- * returns floating point coordinates, for greater precision.
+ * uses floating point coordinates for greater precision.
*/
void
ganv_canvas_w2c_d(GanvCanvas* canvas,
@@ -316,6 +324,7 @@ ganv_canvas_get_item_at(GanvCanvas* canvas, double x, double y);
/**
* ganv_canvas_get_edge:
+ *
* Get the edge between two nodes, or NULL if none exists.
*
* Return value: (transfer none): The root group of @canvas.
@@ -484,6 +493,7 @@ ganv_canvas_for_each_selected_edge(GanvCanvas* canvas,
/**
* ganv_canvas_select_all:
+ *
* Select all items on the canvas.
*/
void
@@ -499,6 +509,7 @@ ganv_canvas_clear_selection(GanvCanvas* canvas);
/**
* ganv_canvas_get_zoom:
+ *
* Return the current zoom factor (pixels per unit).
*/
double
@@ -522,6 +533,7 @@ ganv_canvas_set_zoom(GanvCanvas* canvas, double zoom);
/**
* ganv_canvas_zoom_full:
+ *
* Zoom so all canvas contents are visible.
*/
void
@@ -537,6 +549,7 @@ ganv_canvas_get_default_font_size(const GanvCanvas* canvas);
/**
* ganv_canvas_get_font_size:
+ *
* Get the current font size in points.
*/
double
@@ -544,6 +557,7 @@ ganv_canvas_get_font_size(const GanvCanvas* canvas);
/**
* ganv_canvas_set_font_size:
+ *
* Set the current font size in points.
*/
void
@@ -551,6 +565,7 @@ ganv_canvas_set_font_size(GanvCanvas* canvas, double points);
/**
* ganv_canvas_get_move_cursor:
+ *
* Return the cursor to use while dragging canvas objects.
*/
GdkCursor*
@@ -558,6 +573,7 @@ ganv_canvas_get_move_cursor(const GanvCanvas* canvas);
/**
* ganv_canvas_move_contents_to:
+ *
* Shift all canvas contents so the top-left object is at (x, y).
*/
void
diff --git a/ganv/edge.h b/ganv/edge.h
index c36e0ed..3421ccf 100644
--- a/ganv/edge.h
+++ b/ganv/edge.h
@@ -79,6 +79,7 @@ ganv_edge_unselect(GanvEdge* edge);
/**
* ganv_edge_disconnect:
+ *
* Disconnect the edge. This will disconnect the edge just as if it had been
* disconnected by the user via the canvas. The canvas disconnect signal will
* be emitted, allowing the application to control disconnect logic.
@@ -88,6 +89,7 @@ ganv_edge_disconnect(GanvEdge* edge);
/**
* ganv_edge_remove:
+ *
* Remove the edge from the canvas. This will only remove the edge visually,
* it will not emit the canvas disconnect signal to notify the application.
*/
diff --git a/ganv/module.h b/ganv/module.h
index 4eab012..ae9a07d 100644
--- a/ganv/module.h
+++ b/ganv/module.h
@@ -58,6 +58,7 @@ 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.
diff --git a/gtkdoc.sh b/gtkdoc.sh
index 629053a..42ff39d 100755
--- a/gtkdoc.sh
+++ b/gtkdoc.sh
@@ -23,4 +23,4 @@ cd html && gtkdoc-mkhtml $DOC_MODULE ../ganv-docs.xml && cd -
gtkdoc-fixxref --module=$DOC_MODULE --module-dir=html
echo "gtkdoc.sh: Leaving directory \`$pwd/docs'"
-cd - \ No newline at end of file
+cd -
diff --git a/src/Canvas.cpp b/src/Canvas.cpp
index 7694954..681b437 100644
--- a/src/Canvas.cpp
+++ b/src/Canvas.cpp
@@ -1881,8 +1881,8 @@ ganv_canvas_class_init(GanvCanvasClass* klass)
g_object_class_install_property(
gobject_class, PROP_FOCUSED_ITEM, g_param_spec_object(
"focused-item",
- NULL,
- NULL,
+ _("Focused item"),
+ _("The item that currently has keyboard focus."),
GANV_TYPE_ITEM,
(GParamFlags)(G_PARAM_READABLE | G_PARAM_WRITABLE)));