[gnome-menus/wip/gobject-review: 20/38] Document a few functions



commit 04d7097fe8a75a38cb5741c90e7a6d00aa148e29
Author: Colin Walters <walters verbum org>
Date:   Mon Apr 18 16:17:04 2011 -0400

    Document a few functions

 libmenu/gmenu-tree.c |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)
---
diff --git a/libmenu/gmenu-tree.c b/libmenu/gmenu-tree.c
index cc27c4e..12306bd 100644
--- a/libmenu/gmenu-tree.c
+++ b/libmenu/gmenu-tree.c
@@ -721,6 +721,12 @@ gmenu_tree_item_get_item_type (GMenuTreeItem *item)
   return item->type;
 }
 
+/**
+ * gmenu_tree_directory_get_parent:
+ * @entry: a #GMenuTreeDirectory
+ *
+ * Returns: (transfer full): The parent directory, or %NULL if none
+ */
 GMenuTreeDirectory *
 gmenu_tree_directory_get_parent (GMenuTreeDirectory *directory)
 {
@@ -730,6 +736,12 @@ gmenu_tree_directory_get_parent (GMenuTreeDirectory *directory)
   return item->parent ? gmenu_tree_item_ref (item->parent) : NULL;
 }
 
+/**
+ * gmenu_tree_entry_get_parent:
+ * @entry: a #GMenuTreeEntry
+ *
+ * Returns: (transfer full): The parent directory, or %NULL if none
+ */
 GMenuTreeDirectory *
 gmenu_tree_entry_get_parent (GMenuTreeEntry *entry)
 {
@@ -866,6 +878,12 @@ gmenu_tree_directory_make_path (GMenuTreeDirectory *directory,
   return g_string_free (path, FALSE);
 }
 
+/**
+ * gmenu_tree_entry_get_app_info:
+ * @entry: a #GMenuTreeEntry
+ *
+ * Returns: (transfer none): The #GDesktopAppInfo for this entry
+ */
 GDesktopAppInfo *
 gmenu_tree_entry_get_app_info (GMenuTreeEntry *entry)
 {



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]