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/qml/doc/src/cppintegration | |
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/qml/doc/src/cppintegration')
-rw-r--r-- | src/qml/doc/src/cppintegration/data.qdoc | 6 | ||||
-rw-r--r-- | src/qml/doc/src/cppintegration/definetypes.qdoc | 8 | ||||
-rw-r--r-- | src/qml/doc/src/cppintegration/topic.qdoc | 2 |
3 files changed, 8 insertions, 8 deletions
diff --git a/src/qml/doc/src/cppintegration/data.qdoc b/src/qml/doc/src/cppintegration/data.qdoc index ba8ad47bab..dc1b4cae9c 100644 --- a/src/qml/doc/src/cppintegration/data.qdoc +++ b/src/qml/doc/src/cppintegration/data.qdoc @@ -119,9 +119,9 @@ when passed from C++ to QML and vice-versa: \li \l enumeration \endtable -(Note that classes provided by the QtGui module, such as QColor, QFont, -QQuaternion and QMatrix4x4, are only available from QML when the \l QtQuick -module is imported.) +\note Classes provided by the \l {Qt GUI} module, such as QColor, QFont, +QQuaternion and QMatrix4x4, are only available from QML when the \l {Qt Quick} +module is included. As a convenience, many of these types can be specified in QML by string values, or by a related method provided by the \l {QML:Qt} object. For example, the \l diff --git a/src/qml/doc/src/cppintegration/definetypes.qdoc b/src/qml/doc/src/cppintegration/definetypes.qdoc index b8879ebb04..af7aed251d 100644 --- a/src/qml/doc/src/cppintegration/definetypes.qdoc +++ b/src/qml/doc/src/cppintegration/definetypes.qdoc @@ -291,7 +291,7 @@ qmlRegisterRevision<BaseType,1>("MyTypes", 1, 1); \endcode This is useful when deriving from base classes provided by other authors, -e.g. when extending classes from the QtQuick library. +e.g. when extending classes from the Qt Quick module. \section1 Defining QML-Specific Types and Attributes @@ -677,11 +677,11 @@ to be declared for an item without explicitly assigning them to the \section2 Defining Visual Items with the QtQuick Module -When building user interfaces with the QtQuick module, all QML objects that are +When building user interfaces with the \l {Qt Quick} module, all QML objects that are to be visually rendered must derive from the \l Item type, as it is the base -type for all visual objects in the QtQuick module. This \l Item type is +type for all visual objects in \l {Qt Quick}. This \l Item type is implemented by the QQuickItem C++ class, which is provided as part of the -QtQuick C++ module. Therefore, this class should be subclassed when it is +\l {Qt Quick} C++ module. Therefore, this class should be subclassed when it is necessary to implement a visual type in C++ that can be integrated into a QML-based user interface. diff --git a/src/qml/doc/src/cppintegration/topic.qdoc b/src/qml/doc/src/cppintegration/topic.qdoc index 41645e2379..b6df231b3f 100644 --- a/src/qml/doc/src/cppintegration/topic.qdoc +++ b/src/qml/doc/src/cppintegration/topic.qdoc @@ -43,7 +43,7 @@ with QML and JavaScript within \l{qtqml-documents-topic.html}{QML documents}, an C++ \li Use and invoke some C++ functionality from QML (for example, to invoke your application logic, use a data model implemented in C++, or call some functions in a third-party C++ library) -\li Access functionality in the \l {Qt QML} or QtQuick C++ API (for example, to dynamically generate +\li Access functionality in the \l {Qt QML} or \l {Qt Quick} C++ API (for example, to dynamically generate images using QQuickImageProvider) \li Implement your own \l{qtqml-typesystem-objecttypes.html}{QML object types} from C++ \unicode{0x2014} whether for use within your own specific application, or for distribution to others |