summaryrefslogtreecommitdiff
path: root/src/controls/TabView.qml
diff options
context:
space:
mode:
authorCaroline Chao <caroline.chao@theqtcompany.com>2015-03-12 10:02:36 +0100
committerCaroline Chao <caroline.chao@theqtcompany.com>2015-03-13 14:59:12 +0000
commit95abac09523df5f0563f46ceb5365f80cb87a18c (patch)
treecab91b55cebb14df0bfb20b44ec426b860308c4c /src/controls/TabView.qml
parentd04eb32908cfa7c6692bacfc292494b85ce3cd8a (diff)
downloadqtquickcontrols-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/TabView.qml')
-rw-r--r--src/controls/TabView.qml15
1 files changed, 10 insertions, 5 deletions
diff --git a/src/controls/TabView.qml b/src/controls/TabView.qml
index 84e5331b..bd043be9 100644
--- a/src/controls/TabView.qml
+++ b/src/controls/TabView.qml
@@ -115,14 +115,16 @@ FocusScope {
/*! \internal */
default property alias data: stack.data
- /*! Adds a new tab page with title with and optional Component.
+ /*! \qmlmethod Tab TabView::addTab(string title, Component component)
+ Adds a new tab page with title with and optional Component.
Returns the newly added tab.
*/
function addTab(title, component) {
return insertTab(__tabs.count, title, component)
}
- /*! Inserts a new tab with title at index, with an optional Component.
+ /*! \qmlmethod Tab TabView::insertTab(int index, string title, Component component)
+ Inserts a new tab with title at index, with an optional Component.
Returns the newly added tab.
*/
function insertTab(index, title, component) {
@@ -139,7 +141,8 @@ FocusScope {
return tab
}
- /*! Removes and destroys a tab at the given \a index. */
+ /*! \qmlmethod void TabView::removeTab(int index)
+ Removes and destroys a tab at the given \a index. */
function removeTab(index) {
var tab = __tabs.get(index).tab
__willRemoveIndex(index)
@@ -148,7 +151,8 @@ FocusScope {
__setOpacities()
}
- /*! Moves a tab \a from index \a to another. */
+ /*! \qmlmethod void TabView::moveTab(int from, int to)
+ Moves a tab \a from index \a to another. */
function moveTab(from, to) {
__tabs.move(from, to, 1)
@@ -166,7 +170,8 @@ FocusScope {
}
}
- /*! Returns the \l Tab item at \a index. */
+ /*! \qmlmethod Tab TabView::getTab(int index)
+ Returns the \l Tab item at \a index. */
function getTab(index) {
var data = __tabs.get(index)
return data && data.tab