diff options
| author | Alejandro Exojo <suy@badopi.org> | 2014-12-05 19:46:01 +0100 |
|---|---|---|
| committer | Alejandro Exojo Piqueras <suy@badopi.org> | 2014-12-08 11:38:44 +0100 |
| commit | 1d61e3267da7ff4a2c437ed7c6a591e13eb92076 (patch) | |
| tree | c3e00fad3102d2e669418417a537120f7a4856c2 /src/tools/qdoc/doc | |
| parent | d52ea19862461c7f6f49f8233594d83e1c00cde8 (diff) | |
doc: Clarify \inqmlmodule usage
The \inqmlmodule command only accepts one parameter: the name of the module.
This was producing some confusion, since in qtdeclarative there were some wrong
import statements and it wasn't obvious which command was producing them.
Change-Id: Idb41f12f20f05757942b0957c512d195ec8500b3
Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
Diffstat (limited to 'src/tools/qdoc/doc')
5 files changed, 8 insertions, 7 deletions
diff --git a/src/tools/qdoc/doc/examples/componentset/ProgressBar.qml b/src/tools/qdoc/doc/examples/componentset/ProgressBar.qml index 72e0815d19..f7aeb29865 100644 --- a/src/tools/qdoc/doc/examples/componentset/ProgressBar.qml +++ b/src/tools/qdoc/doc/examples/componentset/ProgressBar.qml @@ -42,7 +42,7 @@ import QtQuick 1.0 /*! \qmltype ProgressBar - \inqmlmodule UIComponents 1.0 + \inqmlmodule UIComponents \brief A component that shows the progress of an event A ProgressBar shows the linear progress of an event as its \l value. diff --git a/src/tools/qdoc/doc/examples/componentset/Switch.qml b/src/tools/qdoc/doc/examples/componentset/Switch.qml index ae760e566e..7dee33eb3c 100644 --- a/src/tools/qdoc/doc/examples/componentset/Switch.qml +++ b/src/tools/qdoc/doc/examples/componentset/Switch.qml @@ -42,7 +42,7 @@ import QtQuick 1.0 /*! \qmltype ToggleSwitch - \inqmlmodule UIComponents 1.0 + \inqmlmodule UIComponents \brief A component that can be turned on or off A toggle switch has two states: an \c on and an \c off state. The \c off diff --git a/src/tools/qdoc/doc/examples/componentset/TabWidget.qml b/src/tools/qdoc/doc/examples/componentset/TabWidget.qml index 337f23fdad..0fbac1604e 100644 --- a/src/tools/qdoc/doc/examples/componentset/TabWidget.qml +++ b/src/tools/qdoc/doc/examples/componentset/TabWidget.qml @@ -42,7 +42,7 @@ import QtQuick 1.0 /*! \qmltype TabWidget - \inqmlmodule UIComponents 1.0 + \inqmlmodule UIComponents \brief A widget that places its children as tabs A TabWidget places its children as tabs in a view. Selecting diff --git a/src/tools/qdoc/doc/examples/qml.qdoc.sample b/src/tools/qdoc/doc/examples/qml.qdoc.sample index d913c6f164..11713b4e4d 100644 --- a/src/tools/qdoc/doc/examples/qml.qdoc.sample +++ b/src/tools/qdoc/doc/examples/qml.qdoc.sample @@ -28,7 +28,7 @@ //![qmltype] \qmltype TextEdit \instantiates QQuickTextEdit - \inqmlmodule QtQuick 2 + \inqmlmodule QtQuick \ingroup qtquick-visual \ingroup qtquick-input \inherits Item diff --git a/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc index b50a343a22..1d78eff386 100644 --- a/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-topiccmds.qdoc @@ -1376,9 +1376,10 @@ \section1 \\inqmlmodule A QML class may belong to a \l{qmlmodule-command}{QML module} by inserting - the \l{inqmlmodule-command}{\\inqmlmodule} command as a topic command. - Every member of a group must be linked to using the module name and two - colons (\c{::}). + the \l{inqmlmodule-command}{\\inqmlmodule} command as a topic command, with + the module name (without a version number) as the only argument. Every + member of a group must be linked to using the module name and two colons + (\c{::}). \code \qmltype ClickableButton |