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>
bb10
Alejandro Exojo 2014-12-05 19:46:01 +01:00 committed by Alejandro Exojo Piqueras
parent d52ea19862
commit 1d61e3267d
5 changed files with 8 additions and 7 deletions

View File

@ -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.

View File

@ -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

View File

@ -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

View File

@ -28,7 +28,7 @@
//![qmltype]
\qmltype TextEdit
\instantiates QQuickTextEdit
\inqmlmodule QtQuick 2
\inqmlmodule QtQuick
\ingroup qtquick-visual
\ingroup qtquick-input
\inherits Item

View File

@ -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