summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCaroline Chao <caroline.chao@digia.com>2013-06-03 10:43:33 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-06-03 14:54:08 +0200
commitcbd4b0f4e83cd458bd0f1ecbb53f1d789dfe9ff7 (patch)
tree429c7d508546f4c9bf0012e67ac8ec439644233e
parent3eee91908e8bd0c5f3c3ebe59ef1e179c8d1eb68 (diff)
downloadqtquickcontrols-cbd4b0f4e83cd458bd0f1ecbb53f1d789dfe9ff7.tar.gz
Doc: Fixes warnings
Fixes issues including: - Misspelled links - Links to signal with arguments - \table in SplitView.qml - Links to current file Change-Id: I2cbadf661a641f19ed55f6854922b2b69966bc9c Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
-rw-r--r--src/controls/Button.qml2
-rw-r--r--src/controls/SplitView.qml8
-rw-r--r--src/controls/TableView.qml5
-rw-r--r--src/controls/ToolButton.qml2
-rw-r--r--src/controls/qquickaction.cpp10
-rw-r--r--src/controls/qquickexclusivegroup.cpp16
-rw-r--r--src/controls/qquickmenu.cpp4
-rw-r--r--src/controls/qquickmenuitem.cpp10
8 files changed, 28 insertions, 29 deletions
diff --git a/src/controls/Button.qml b/src/controls/Button.qml
index 1a9b198e..21231e57 100644
--- a/src/controls/Button.qml
+++ b/src/controls/Button.qml
@@ -80,7 +80,7 @@ BasicButton {
property string text
/*! This property holds the icon shown on the button. If the button has no
- icon, the \l iconSource property will be an empty string.
+ icon, the iconSource property will be an empty string.
The default value is the empty string.
*/
diff --git a/src/controls/SplitView.qml b/src/controls/SplitView.qml
index aba7809f..ff44a03a 100644
--- a/src/controls/SplitView.qml
+++ b/src/controls/SplitView.qml
@@ -130,12 +130,12 @@ Item {
child item. Inside the delegate the following properties are available:
\table
- \li readonly property bool styleData.index - Specifies the index of the splitter handle. The handle
+ \row \li readonly property bool styleData.index \li Specifies the index of the splitter handle. The handle
between the first and the second item will get index 0,
the next handle index 1 etc.
- \li readonly property bool styleData.hovered - The handle is being hovered.
- \li readonly property bool styleData.pressed - The handle is being pressed.
- \li readonly property bool styleData.resizing - The handle is being dragged.
+ \row \li readonly property bool styleData.hovered \li The handle is being hovered.
+ \row \li readonly property bool styleData.pressed \li The handle is being pressed.
+ \row \li readonly property bool styleData.resizing \li The handle is being dragged.
\endtable
*/
diff --git a/src/controls/TableView.qml b/src/controls/TableView.qml
index 88a897e1..f6a8ed4b 100644
--- a/src/controls/TableView.qml
+++ b/src/controls/TableView.qml
@@ -65,8 +65,7 @@ import QtQuick.Controls.Styles 1.0
\endcode
You provide title and size of a column header
- by adding a \l TableViewColumn to the default \l header property
- as demonstrated below.
+ by adding a \l TableViewColumn as demonstrated below.
\code
TableView {
@@ -259,7 +258,7 @@ ScrollView {
Depending on how the model is populated, the model may not be ready when
TableView Component.onCompleted is called. In that case you may need to
- delay the call to positionViewAtRow by using a \l {Timer}.
+ delay the call to positionViewAtRow by using a \l {QtQml::Timer}{Timer}.
\note This method should only be called after the component has completed.
*/
diff --git a/src/controls/ToolButton.qml b/src/controls/ToolButton.qml
index d6607d28..6cd3661b 100644
--- a/src/controls/ToolButton.qml
+++ b/src/controls/ToolButton.qml
@@ -46,7 +46,7 @@ import QtQuick.Controls.Private 1.0
\qmltype ToolButton
\inqmlmodule QtQuick.Controls 1.0
\since QtQtuick.Controls 1.0
- \ingroup applicationwindow
+ \ingroup controls
\brief Provides a button type that is typically used within a ToolBar.
ToolButton is functionally similar to \l Button, but can provide a look that is more
diff --git a/src/controls/qquickaction.cpp b/src/controls/qquickaction.cpp
index a597515f..e240d111 100644
--- a/src/controls/qquickaction.cpp
+++ b/src/controls/qquickaction.cpp
@@ -123,7 +123,7 @@ QT_BEGIN_NAMESPACE
Whether the action is enabled, and can be triggered. Defaults to \c true.
- \sa tigger(), triggered()
+ \sa trigger(), triggered
*/
/*!
@@ -140,7 +140,7 @@ QT_BEGIN_NAMESPACE
If the action is \l checkable, this property reflects its checked state. Defaults to \c false.
Its value is also false while \l checkable is false.
- \sa toggled(), exclusiveGroup
+ \sa toggled, exclusiveGroup
*/
/*!
@@ -169,14 +169,14 @@ QT_BEGIN_NAMESPACE
/*! \qmlmethod Action::trigger()
- Will emit the \l triggered() signal if the action is enabled. Will also emit the
- \l toggled() signal if it is checkable.
+ Will emit the \l triggered signal if the action is enabled. Will also emit the
+ \l toggled signal if it is checkable.
*/
/*! \qmlsignal Action::toggled(checked)
Emitted whenever a action's \l checked property changes.
- This usually happens at the same time as \l triggered().
+ This usually happens at the same time as \l triggered.
*/
QQuickAction::QQuickAction(QObject *parent)
diff --git a/src/controls/qquickexclusivegroup.cpp b/src/controls/qquickexclusivegroup.cpp
index eecff416..f1b6935e 100644
--- a/src/controls/qquickexclusivegroup.cpp
+++ b/src/controls/qquickexclusivegroup.cpp
@@ -97,9 +97,9 @@ static bool isChecked(const QObject *o)
}
\endcode
- Several controls already support \l ExclusiveGroup, e.g. \l Action, \l MenuItem, \l Button, and \l RadioButton.
+ Several controls already support ExclusiveGroup, e.g. \l Action, \l MenuItem, \l Button, and \l RadioButton.
- Since \l ExclusiveGroup only supports \l Action as child items, we need to manually assign the \c exclusiveGroup
+ Since ExclusiveGroup only supports \l Action as child items, we need to manually assign the \c exclusiveGroup
property for other objects.
\code
@@ -131,9 +131,9 @@ static bool isChecked(const QObject *o)
\section1 Adding support to ExclusiveGroup
- It is possible to add support for \l ExclusiveGroup for an object, or control. It should have a \c checked
+ It is possible to add support for ExclusiveGroup for an object, or control. It should have a \c checked
property, and either a \c checkedChanged, \c toggled(), or \c toggled(bool) signal. It also needs
- to be bound with \l ExclusiveGroup::bindCheckable(object) when its \l ExclusiveGroup ty[ped property is set.
+ to be bound with \l ExclusiveGroup::bindCheckable() when its ExclusiveGroup ty[ped property is set.
\code
Item {
@@ -149,13 +149,13 @@ static bool isChecked(const QObject *o)
}
\endcode
- The example above shows the minimum necessary to add \l ExclusiveGroup support to any item.
+ The example above shows the minimum necessary to add ExclusiveGroup support to any item.
*/
/*!
\qmlproperty object ExclusiveGroup::current
- The currently selected object. Defaults to the first checked object bound to the \l ExclusiveGroup.
+ The currently selected object. Defaults to the first checked object bound to the ExclusiveGroup.
If there is none, then it defaults to \c null.
*/
@@ -166,7 +166,7 @@ static bool isChecked(const QObject *o)
You should only need to call this function when creating a component you want to be compatible with \c ExclusiveGroup.
- \sa ExclusiveGroup::unbindCheckable(object)
+ \sa ExclusiveGroup::unbindCheckable()
*/
/*!
@@ -176,7 +176,7 @@ static bool isChecked(const QObject *o)
You should only need to call this function when creating a component you want to be compatible with \c ExclusiveGroup.
- \sa ExclusiveGroup::bindCheckable(object)
+ \sa ExclusiveGroup::bindCheckable()
*/
QQuickExclusiveGroup::QQuickExclusiveGroup(QObject *parent)
diff --git a/src/controls/qquickmenu.cpp b/src/controls/qquickmenu.cpp
index efc49cd6..bb0ddae9 100644
--- a/src/controls/qquickmenu.cpp
+++ b/src/controls/qquickmenu.cpp
@@ -100,7 +100,7 @@ QT_BEGIN_NAMESPACE
\endcode
Note that in this case, the \c index parameter passed to \l insertItem() is relative
- to the position of the \l Instatiator in the menu, as opposed to absolute position
+ to the position of the \l Instantiator in the menu, as opposed to absolute position
in the menu.
\sa MenuItem, MenuSeparator
@@ -170,7 +170,7 @@ QT_BEGIN_NAMESPACE
Adds an item to the menu. Returns the newly created \l MenuItem.
- \sa insertItem(int before, string title)
+ \sa insertItem()
*/
/*!
diff --git a/src/controls/qquickmenuitem.cpp b/src/controls/qquickmenuitem.cpp
index de215df1..622fdd2d 100644
--- a/src/controls/qquickmenuitem.cpp
+++ b/src/controls/qquickmenuitem.cpp
@@ -329,14 +329,14 @@ void QQuickMenuText::updateIcon()
Emitted when either the menu item or its bound action have been activated.
- \sa trigger(), Action::triggered(), Action::toggled()
+ \sa trigger(), Action::triggered, Action::toggled
*/
/*! \qmlmethod MenuItem::trigger()
Manually trigger a menu item. Will also trigger the item's bound action.
- \sa triggered(), Action::trigger()
+ \sa triggered, Action::trigger()
*/
/*!
@@ -360,7 +360,7 @@ void QQuickMenuText::updateIcon()
If the menu item is checkable, this property reflects its checked state. Defaults to \c false.
- \sa checkable, Action::toggled()
+ \sa checkable, Action::toggled
*/
/*! \qmlproperty ExclusiveGroup MenuItem::exclusiveGroup
@@ -378,9 +378,9 @@ void QQuickMenuText::updateIcon()
/*! \qmlsignal MenuItem::toggled(checked)
Emitted whenever a menu item's \c checked property changes.
- This usually happens at the same time as \l triggered().
+ This usually happens at the same time as \l triggered.
- \sa checked, triggered(), Action::triggered(), Action::toggled()
+ \sa checked, triggered, Action::triggered, Action::toggled
*/
/*!