Update gtk-doc documentation.

This commit is contained in:
Přemysl Eric Janouch 2011-02-02 17:26:04 +01:00
parent 2744d84896
commit f864693f1b
4 changed files with 7 additions and 6 deletions

View File

@ -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)

View File

@ -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)

View File

@ -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)

View File

@ -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.