From 1636cb60845356de277b2ffac3aa8305c41ee56b Mon Sep 17 00:00:00 2001 From: Gabriel de Dietrich Date: Wed, 20 Mar 2013 20:45:43 +0100 Subject: Several documentation improvements Includes Menu, MenuItem, Action, and ExclusiveGroup. Change-Id: I447c36fe361bbad2f5a31584f242601a150832fa Reviewed-by: Jerome Pasion --- src/controls/Menu.qml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) (limited to 'src/controls/Menu.qml') diff --git a/src/controls/Menu.qml b/src/controls/Menu.qml index 6ac930ef..6c2d3cc4 100644 --- a/src/controls/Menu.qml +++ b/src/controls/Menu.qml @@ -46,8 +46,8 @@ import "Styles/Settings.js" as Settings /*! \qmltype Menu \inqmlmodule QtQuick.Controls 1.0 - \ingroup applicationwindow - \brief Provides a menu component for use in menu bars, context menus, + \ingroup menus + \brief Provides a menu component for use in menu bars, as context menu, and other popup menus. \code @@ -85,14 +85,14 @@ import "Styles/Settings.js" as Settings \endcode The main uses for menus: - \table - \row + \list + \li as a \e top-level menu in a \l MenuBar - \row + \li as a \e submenu inside another menu - \row + \li as a standalone or \e context menu - \endtable + \endlist Note that some properties, such as \c enabled, \c text, or \c iconSource, only make sense in a particular use case of the menu. @@ -103,8 +103,10 @@ import "Styles/Settings.js" as Settings MenuPrivate { id: root - /*! - Adds a submenu to the menu. Returns the newly created \l Menu. + /*! \internal + \omit + See qtmenu.cpp. + \endomit */ function addMenu(title) { if (!__selfComponent) @@ -114,7 +116,7 @@ MenuPrivate { return submenu } - /*! internal */ + /*! \internal */ property Component __selfComponent: null /*! \internal */ -- cgit v1.2.1