summaryrefslogtreecommitdiff
path: root/libnautilus-extension/nautilus-menu-item.c
diff options
context:
space:
mode:
authorCosimo Cecchi <cosimoc@gnome.org>2015-05-25 20:33:13 -0700
committerCosimo Cecchi <cosimoc@gnome.org>2015-05-25 20:41:19 -0700
commitff5a48d13343eccc5d8fb2772aa8b83afdeb0f3a (patch)
tree7faae561dbd14a323d88f7b9620b9e877df4b535 /libnautilus-extension/nautilus-menu-item.c
parent545a7660fa7758f506e9aef198fe6786a84b982a (diff)
downloadnautilus-ff5a48d13343eccc5d8fb2772aa8b83afdeb0f3a.tar.gz
libnautilus-extension: add gtk-doc documentation coverage
A lot of the library was poorly documented. Make sure the output of the documentation looks okay.
Diffstat (limited to 'libnautilus-extension/nautilus-menu-item.c')
-rw-r--r--libnautilus-extension/nautilus-menu-item.c14
1 files changed, 14 insertions, 0 deletions
diff --git a/libnautilus-extension/nautilus-menu-item.c b/libnautilus-extension/nautilus-menu-item.c
index f0c5fed48..ee582dcde 100644
--- a/libnautilus-extension/nautilus-menu-item.c
+++ b/libnautilus-extension/nautilus-menu-item.c
@@ -57,6 +57,20 @@ static guint signals[LAST_SIGNAL];
static GObjectClass *parent_class = NULL;
/**
+ * SECTION:nautilus-menu-item
+ * @title: NautilusMenuItem
+ * @short_description: Menu item descriptor object
+ * @include: libnautilus-extension/nautilus-menu-item.h
+ *
+ * #NautilusMenuItem is an object that describes an item in a file manager
+ * menu. Extensions can provide #NautilusMenuItem objects by registering a
+ * #NautilusMenuProvider and returning them from
+ * nautilus_menu_provider_get_file_items(), or
+ * nautilus_menu_provider_get_background_items(), which will be called by the
+ * main application when creating menus.
+ */
+
+/**
* nautilus_menu_item_new:
* @name: the identifier for the menu item
* @label: the user-visible label of the menu item