aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPřemysl Janouch <p.janouch@gmail.com>2011-02-02 17:26:04 +0100
committerPřemysl Janouch <p.janouch@gmail.com>2011-02-02 17:26:04 +0100
commitf864693f1bac4617f1ae8e42cd847ccf5e57055f (patch)
tree605d45535934ad588d05cb8cc66a7d0c124857f9
parent2744d848964e0983be6a90be92e50bb110215b26 (diff)
downloadlogdiag-f864693f1bac4617f1ae8e42cd847ccf5e57055f.tar.gz
logdiag-f864693f1bac4617f1ae8e42cd847ccf5e57055f.tar.xz
logdiag-f864693f1bac4617f1ae8e42cd847ccf5e57055f.zip
Update gtk-doc documentation.
-rw-r--r--liblogdiag/ld-diagram.c7
-rw-r--r--liblogdiag/ld-library.c2
-rw-r--r--liblogdiag/ld-symbol-category.c2
-rw-r--r--liblogdiag/ld-undo-action.c2
4 files changed, 7 insertions, 6 deletions
diff --git a/liblogdiag/ld-diagram.c b/liblogdiag/ld-diagram.c
index 18a0993..3120c58 100644
--- a/liblogdiag/ld-diagram.c
+++ b/liblogdiag/ld-diagram.c
@@ -852,7 +852,8 @@ uninstall_object (LdDiagramObject *object, LdDiagram *self)
* ld_diagram_get_objects:
* @self: an #LdDiagram object.
*
- * Get a list of objects in the diagram. Do not modify.
+ * Return value: (element-type LdDiagramObject): a list of all objects
+ * in the diagram. Do not modify.
*/
GList *
ld_diagram_get_objects (LdDiagram *self)
@@ -950,8 +951,8 @@ ld_diagram_remove_object (LdDiagram *self, LdDiagramObject *object)
* ld_diagram_get_selection:
* @self: an #LdDiagram object.
*
- * Get a list of objects that are currently selected in the diagram.
- * Do not modify.
+ * Return value: (element-type LdDiagramObject): a list of objects that
+ * are currently selected in the diagram. Do not modify.
*/
GList *
ld_diagram_get_selection (LdDiagram *self)
diff --git a/liblogdiag/ld-library.c b/liblogdiag/ld-library.c
index 4a56929..399d4f2 100644
--- a/liblogdiag/ld-library.c
+++ b/liblogdiag/ld-library.c
@@ -513,7 +513,7 @@ ld_library_remove_child (LdLibrary *self, GObject *child)
* ld_library_get_children:
* @self: an #LdLibrary object.
*
- * Return value: the internal list of children. Do not modify.
+ * Return value: (element-type GObject): a list of children. Do not modify.
*/
const GSList *
ld_library_get_children (LdLibrary *self)
diff --git a/liblogdiag/ld-symbol-category.c b/liblogdiag/ld-symbol-category.c
index d4ac3cb..4ca51de 100644
--- a/liblogdiag/ld-symbol-category.c
+++ b/liblogdiag/ld-symbol-category.c
@@ -328,7 +328,7 @@ ld_symbol_category_remove_child (LdSymbolCategory *self,
* ld_symbol_category_get_children:
* @self: an #LdSymbolCategory object.
*
- * Return value: the internal list of children. Do not modify.
+ * Return value: (element-type GObject): a list of children. Do not modify.
*/
const GSList *
ld_symbol_category_get_children (LdSymbolCategory *self)
diff --git a/liblogdiag/ld-undo-action.c b/liblogdiag/ld-undo-action.c
index 924a03e..1cbd4c2 100644
--- a/liblogdiag/ld-undo-action.c
+++ b/liblogdiag/ld-undo-action.c
@@ -16,7 +16,7 @@
/**
* SECTION:ld-undo-action
- * @short_description: An action that can be undone.
+ * @short_description: An action that can be undone
* @see_also: #LdDiagram, #LdDiagramObject
*
* #LdUndoAction represents an action that can be reverted.