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/extras | |
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/extras')
-rw-r--r-- | src/extras/Tumbler.qml | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/src/extras/Tumbler.qml b/src/extras/Tumbler.qml index 4743322b..7cba6ed0 100644 --- a/src/extras/Tumbler.qml +++ b/src/extras/Tumbler.qml @@ -136,6 +136,11 @@ import QtQuick.Layouts 1.0 Control { id: tumbler + /* + \qmlproperty Component Tumbler::style + + The style Component for this control. + */ style: Settings.styleComponent(Settings.style, "TumblerStyle.qml", tumbler) ListModel { @@ -160,6 +165,7 @@ Control { } /*! + \qmlmethod int Tumbler::currentIndexAt(int columnIndex) Returns the current index of the column at \a columnIndex, or \c null if the \a index is invalid. */ @@ -171,6 +177,7 @@ Control { } /*! + \qmlmethod void Tumbler::setCurrentIndexAt(int columnIndex, int itemIndex) Sets the current index of the column at \a columnIndex to \a itemIndex. Does nothing if \a columnIndex or \a itemIndex are invalid. @@ -190,7 +197,8 @@ Control { } /*! - Returns the column at \a columnIndex or \c null if the \a index is + \qmlmethod TumblerColumn Tumbler::getColumn(int columnIndex) + Returns the column at \a columnIndex or \c null if the index is invalid. */ function getColumn(columnIndex) { @@ -201,10 +209,11 @@ Control { } /*! + \qmlmethod TumblerColumn Tumbler::addColumn(TumblerColumn column) Adds a \a column and returns the added column. The \a column argument can be an instance of TumblerColumn, - or a Component. The component has to contain a TumblerColumn. + or a \l Component. The component has to contain a TumblerColumn. Otherwise \c null is returned. */ function addColumn(column) { @@ -212,10 +221,11 @@ Control { } /*! + \qmlmethod TumblerColumn Tumbler::insertColumn(int index, TumblerColumn column) Inserts a \a column at the given \a index and returns the inserted column. The \a column argument can be an instance of TumblerColumn, - or a Component. The component has to contain a TumblerColumn. + or a \l Component. The component has to contain a TumblerColumn. Otherwise, \c null is returned. */ function insertColumn(index, column) { |