diff options
| author | Sze Howe Koh <szehowe.koh@gmail.com> | 2013-04-17 23:03:16 +0800 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-04-23 18:29:25 +0200 |
| commit | 59f075df52f5e78b95b360fb0533c2249924e7a7 (patch) | |
| tree | eab4bff86cbabf6ced5beed81238c5744a53d53e /src/quick/doc/src/qmltypereference.qdoc | |
| parent | ee2a4a90cdfc024d452ca82dfb2e1d84c050595f (diff) | |
Doc: Qt Quick: Fix module name format (Pt 1/2)
Follow the conventions at
http://qt-project.org/wiki/Spelling_Module_Names_in_Qt_Documentation
Attempt to differentiate between the whole module ("Qt Quick") and the
QML import ("QtQuick") by encoding the latter with monospace font. There
are places in the text where both representations are valid.
Change-Id: Id6e157a4191aaa4e23a9cd5c76abfe902fe43d33
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/quick/doc/src/qmltypereference.qdoc')
| -rw-r--r-- | src/quick/doc/src/qmltypereference.qdoc | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/quick/doc/src/qmltypereference.qdoc b/src/quick/doc/src/qmltypereference.qdoc index 14f0151a3b..413d5aae9c 100644 --- a/src/quick/doc/src/qmltypereference.qdoc +++ b/src/quick/doc/src/qmltypereference.qdoc @@ -36,19 +36,19 @@ interfaces and applications with QML. This page lists every QML type provided by this module, organized according to category and purpose. -\section1 Importing QtQuick +\section1 Importing \c QtQuick -The types provided by the QtQuick module are only available in a QML document +The types provided by the \l {Qt Quick} module are only available in a QML document if that document imports the \c QtQuick namespace. -The current version of the QtQuick module is version 2.0, and thus it may be +The current version of the \c QtQuick module is version 2.0, and thus it may be imported via the following statement: \qml import QtQuick 2.0 \endqml -See the QtQuick module documentation for more +See the \l {Qt Quick} module documentation for more information about the concepts which are central to \c QtQuick. \section2 Submodules @@ -72,12 +72,12 @@ There are a number of basic types that are \l{qtqml-typesystem-basictypes.html#basic-types-provided-by-the-qml-language} {supported by default in the QML language}. -In addition, the QtQuick module provides the following basic types: +In addition, the \c QtQuick module provides the following basic types: \annotatedlist qtquickbasictypes \section1 Object Types -All of the object types provided by QtQuick are based on the \l{Item} type, +All of the object types provided by \c QtQuick are based on the \l{Item} type, which itself derives from \l{QML::QtObject}. \l{qtqml-typereference-topic.html#object-types} {QML object types} provided by the Qt QML module (such as \l{QML::QtObject} and \l{QML::Component}) are also available when @@ -286,14 +286,14 @@ Data Storage /*! \qmlmodule QtQuick 2 -\brief The QtQuick 2 module provides graphical primitives for use in QML. +\brief The \c {QtQuick 2} module provides graphical primitives for use in QML. -The QtQuick 2 module provides graphical primitive types. They can be used with the following import +The \c {QtQuick 2} module provides graphical primitive types. They can be used with the following import \code import QtQuick 2.1 \endcode -For a more detailed listing of types in the \c QtQuick 2 import, see the \l{Qt Quick QML Types} page. +For a more detailed listing of types in the \c {QtQuick 2} import, see the \l{Qt Quick QML Types} page. For more details about the module itself, see the \l{Qt Quick} module page. */ |