diff options
author | Caroline Chao <caroline.chao@theqtcompany.com> | 2015-03-12 10:02:36 +0100 |
---|---|---|
committer | Caroline Chao <caroline.chao@theqtcompany.com> | 2015-03-13 14:59:12 +0000 |
commit | 95abac09523df5f0563f46ceb5365f80cb87a18c (patch) | |
tree | cab91b55cebb14df0bfb20b44ec426b860308c4c /src/controls/Styles/Base | |
parent | d04eb32908cfa7c6692bacfc292494b85ce3cd8a (diff) | |
download | qtquickcontrols-95abac09523df5f0563f46ceb5365f80cb87a18c.tar.gz |
Doc: Fix qml method signatures
So the return value and parameters can be seen in the documentation.
+ Fix minor doc issues
Change-Id: I99e520c103bb0faeb88b26eb7b9ff73922851abc
Reviewed-by: J-P Nurmi <jpnurmi@theqtcompany.com>
Reviewed-by: Martin Smith <martin.smith@digia.com>
Diffstat (limited to 'src/controls/Styles/Base')
-rw-r--r-- | src/controls/Styles/Base/CircularGaugeStyle.qml | 2 | ||||
-rw-r--r-- | src/controls/Styles/Base/DialStyle.qml | 2 | ||||
-rw-r--r-- | src/controls/Styles/Base/MenuBarStyle.qml | 4 | ||||
-rw-r--r-- | src/controls/Styles/Base/MenuStyle.qml | 4 | ||||
-rw-r--r-- | src/controls/Styles/Base/PieMenuStyle.qml | 3 |
5 files changed, 11 insertions, 4 deletions
diff --git a/src/controls/Styles/Base/CircularGaugeStyle.qml b/src/controls/Styles/Base/CircularGaugeStyle.qml index 99b0091b..5abe1469 100644 --- a/src/controls/Styles/Base/CircularGaugeStyle.qml +++ b/src/controls/Styles/Base/CircularGaugeStyle.qml @@ -238,7 +238,7 @@ Style { */ readonly property int labelCount: control.__panel.circularTickmarkLabel.labelCount - /*! + /*! \qmlmethod real CircularGaugeStyle::valueToAngle(real value) Returns \a value as an angle in degrees. This function is useful for custom drawing or positioning of items in diff --git a/src/controls/Styles/Base/DialStyle.qml b/src/controls/Styles/Base/DialStyle.qml index dc4f370d..6c9a68d3 100644 --- a/src/controls/Styles/Base/DialStyle.qml +++ b/src/controls/Styles/Base/DialStyle.qml @@ -144,7 +144,7 @@ Style { */ readonly property int labelCount: control.__panel.circularTickmarkLabel.labelCount - /*! + /*! \qmlmethod real DialStyle::valueToAngle(real value) Returns \a value as an angle in degrees. This function is useful for custom drawing or positioning of items in diff --git a/src/controls/Styles/Base/MenuBarStyle.qml b/src/controls/Styles/Base/MenuBarStyle.qml index aaad65e8..541dd7f9 100644 --- a/src/controls/Styles/Base/MenuBarStyle.qml +++ b/src/controls/Styles/Base/MenuBarStyle.qml @@ -52,7 +52,9 @@ import QtQuick.Controls.Private 1.0 Style { id: root - /*! Returns a formatted string to render mnemonics for a given menu item. + /*! + \qmlmethod string MenuBarStyle::formatMnemonic(string text, bool underline = false) + Returns a formatted string to render mnemonics for a given menu item. The mnemonic character is prefixed by an ampersand in the original string. diff --git a/src/controls/Styles/Base/MenuStyle.qml b/src/controls/Styles/Base/MenuStyle.qml index 6e9f8b0e..a2a3862f 100644 --- a/src/controls/Styles/Base/MenuStyle.qml +++ b/src/controls/Styles/Base/MenuStyle.qml @@ -93,7 +93,9 @@ Style { /*! The number of milliseconds to wait before opening a submenu. */ property int submenuPopupDelay: 200 - /*! Returns a rich-text string to render mnemonics for a given menu item. + /*! + \qmlmethod string MenuStyle::formatMnemonic(string text, bool underline = false) + Returns a rich-text string to render mnemonics for a given menu item. The mnemonic character is prefixed by an ampersand in the original string. diff --git a/src/controls/Styles/Base/PieMenuStyle.qml b/src/controls/Styles/Base/PieMenuStyle.qml index 916a0c9e..fdfa92e7 100644 --- a/src/controls/Styles/Base/PieMenuStyle.qml +++ b/src/controls/Styles/Base/PieMenuStyle.qml @@ -165,6 +165,7 @@ Style { property real endAngle: 90 /*! + \qmlmethod real PieMenuStyle::sectionStartAngle(int itemIndex) Returns the start of the section at \a itemIndex as an angle in degrees. */ function sectionStartAngle(itemIndex) { @@ -172,6 +173,7 @@ Style { } /*! + \qmlmethod real PieMenuStyle::sectionCenterAngle(int itemIndex) Returns the center of the section at \a itemIndex as an angle in degrees. */ @@ -180,6 +182,7 @@ Style { } /*! + \qmlmethod real PieMenuStyle::sectionEndAngle(int itemIndex) Returns the end of the section at \a itemIndex as an angle in degrees. */ function sectionEndAngle(itemIndex) { |