finch/libgnt/gntmenu.h

branch
soc.2013.gobjectification.plugins
changeset 37051
f1ba94fd20f1
parent 37035
e85ed7f4d6e3
parent 35408
5f7ccec14f33
child 37064
3373bd0b4ea6
--- a/finch/libgnt/gntmenu.h	Sun Feb 02 01:22:13 2014 +0530
+++ b/finch/libgnt/gntmenu.h	Sun Feb 02 03:49:31 2014 +0530
@@ -49,14 +49,18 @@
 #include "gntmenuitem.h"
 
 /**
+ * GntMenuType:
+ * @GNT_MENU_TOPLEVEL: Menu for a toplevel window
+ * @GNT_MENU_POPUP:    A popup menu
+ *
  * A toplevel-menu is displayed at the top of the screen, and it spans accross
  * the entire width of the screen.
  * A popup-menu could be displayed, for example, as a context menu for widgets.
  */
 typedef enum
 {
-	GNT_MENU_TOPLEVEL = 1,  /* Menu for a toplevel window */
-	GNT_MENU_POPUP,         /* A popup menu */
+	GNT_MENU_TOPLEVEL = 1,
+	GNT_MENU_POPUP,
 } GntMenuType;
 
 struct _GntMenu
@@ -86,36 +90,41 @@
 G_BEGIN_DECLS
 
 /**
+ * gnt_menu_get_gtype:
+ *
  * Returns:  The GType for GntMenu.
  */
 GType gnt_menu_get_gtype(void);
 
 /**
- * Create a new menu.
+ * gnt_menu_new:
+ * @type:  The type of the menu, whether it's a toplevel menu or a popup menu.
  *
- * @type:  The type of the menu, whether it's a toplevel menu or a popup menu.
+ * Create a new menu.
  *
  * Returns:  The newly created menu.
  */
 GntWidget * gnt_menu_new(GntMenuType type);
 
 /**
- * Add an item to the menu.
- *
+ * gnt_menu_add_item:
  * @menu:   The menu.
  * @item:   The item to add to the menu.
+ *
+ * Add an item to the menu.
  */
 void gnt_menu_add_item(GntMenu *menu, GntMenuItem *item);
 
 /**
- * Return the GntMenuItem with the given ID.
- *
+ * gnt_menu_get_item:
  * @menu:   The menu.
  * @id:     The ID for an item.
  *
+ * Return the GntMenuItem with the given ID.
+ *
  * Returns:  The menuitem with the given ID, or %NULL.
  *
- * @since 2.3.0
+ * Since: 2.3.0
  */
 GntMenuItem *gnt_menu_get_item(GntMenu *menu, const char *id);
 

mercurial