[glibmm/glibmm-2-64] Gio::MenuModel: Improve documentation of enums
- From: Kjell Ahlstedt <kjellahl src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm/glibmm-2-64] Gio::MenuModel: Improve documentation of enums
- Date: Fri, 11 Dec 2020 14:59:53 +0000 (UTC)
commit 0423cd95597856644c76599e1854b675093b6cd2
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date: Fri Dec 11 15:56:51 2020 +0100
Gio::MenuModel: Improve documentation of enums
Improve the documentation of enums Gio::MenuAttribute and Gio::MenuLink.
See #78
gio/src/menumodel.hg | 41 ++++++++++++++++++++++++++++++++++++-----
1 file changed, 36 insertions(+), 5 deletions(-)
---
diff --git a/gio/src/menumodel.hg b/gio/src/menumodel.hg
index 0402ee7e..e64932dc 100644
--- a/gio/src/menumodel.hg
+++ b/gio/src/menumodel.hg
@@ -24,24 +24,55 @@ _PINCLUDE(glibmm/private/object_p.h)
namespace Gio
{
+// Keep the enum values in sync with giomm_get_menu_attribute() in menumodel.ccg.
+/** Attributes in Gio::MenuModel::get_item_attribute().
+ *
+ * @ingroup giommEnums
+ */
enum MenuAttribute
{
- /// The "action" menu attribute.
+ /** The "action" menu attribute.
+ *
+ * The menu item attribute which holds the action name of the item. %Action
+ * names are namespaced with an identifier for the action group in which the
+ * action resides. For example, "win." for window-specific actions and "app."
+ * for application-wide actions.
+ */
MENU_ATTRIBUTE_ACTION,
- /// The "label" menu attribute.
+ /** The "label" menu attribute.
+ *
+ * The menu item attribute which holds the label of the item.
+ */
MENU_ATTRIBUTE_LABEL,
- /// The "target" menu attribute.
+ /** The "target" menu attribute.
+ *
+ * The menu item attribute which holds the target with which the item's action
+ * will be activated.
+ */
MENU_ATTRIBUTE_TARGET
};
+// Keep the enum values in sync with giomm_get_menu_link() in menumodel.ccg.
+/** %Link types in Gio::MenuModel::get_item_link().
+ *
+ * @ingroup giommEnums
+ */
enum MenuLink
{
- /// The "section" menu link.
+ /** The "section" menu link.
+ *
+ * The name of the link that associates a menu item with a section. The linked
+ * menu will usually be shown in place of the menu item, using the item's label
+ * as a header.
+ */
MENU_LINK_SECTION,
- /// The "submenu" menu link.
+ /** The "submenu" menu link.
+ *
+ * The name of the link that associates a menu item with a submenu.
+ */
MENU_LINK_SUBMENU
};
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]