diff options
author | Chris Adams <christopher.adams@nokia.com> | 2012-07-10 16:52:53 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-07-16 06:47:57 +0200 |
commit | fc56909bbd7444ae6536bed0ddab21f64e0949e7 (patch) | |
tree | 8ec6c6b403d5d79c51a2688bfec6adbcb6c53707 /src/qml/doc/src/qmltypereference.qdoc | |
parent | 89cdaa901d227bed35f6c5405ce5d62f352a659c (diff) |
Improve QtQml module documentation
General improvements, including:
- fixing broken links
- improving topic page content
- fixing incorrect qdoc commands
Change-Id: I50b6733b51cdabf9cecd96046f6e7f41260a9a4b
Reviewed-by: Michael Brasser <michael.brasser@nokia.com>
Diffstat (limited to 'src/qml/doc/src/qmltypereference.qdoc')
-rw-r--r-- | src/qml/doc/src/qmltypereference.qdoc | 31 |
1 files changed, 16 insertions, 15 deletions
diff --git a/src/qml/doc/src/qmltypereference.qdoc b/src/qml/doc/src/qmltypereference.qdoc index 0cb3f31ada..01b2578c23 100644 --- a/src/qml/doc/src/qmltypereference.qdoc +++ b/src/qml/doc/src/qmltypereference.qdoc @@ -33,36 +33,36 @@ The Qt QML module provides the definition and implementation of the QML language, and it also provides some elementary QML types which provide the basis for further extensions to the QML language. - - The Qt QML module also provides the \c QtObject and \c Component types which may be used in QML documents, by default. These types are non-visual and provide building-blocks for extensions to QML. - - \section1 The QtQml Import The types provided by the Qt QML module are only available in a QML document if that document imports the QtQml namespace (or if the document imports the -QtQuick namespace, as noted below). +\c QtQuick namespace, as noted below). The current version of the import provided by the Qt QML module is version 2.0, and thus it may be imported via the following statement: -\tt{import QtQml 2.0} +\qml +import QtQml 2.0 +\endqml -Most clients will never need to use the QtQml import, as all of the types and -functionality provided by the QtQml namespace are also provided by the QtQuick -namespace which may be imported as follows: +Most clients will never need to use the \c QtQml import, as all of the types +and functionality provided by the \c QtQml namespace are also provided by the +\c QtQuick namespace which may be imported as follows: -\tt{import QtQuick 2.0} +\qml +import QtQuick 2.0 +\endqml -See the \l{Qt Quick} module documentation for more information about the -QtQuick namespace and what it provides to QML application developers. +See the \l{QtQuick}{Qt Quick} module documentation for more information about the +\c QtQuick namespace and what it provides to QML application developers. The documentation for the types below applies equally to the types of the same -name provided by the Qt Quick module, as they are in fact identical. +name provided by the \l{QtQuick}{Qt Quick} module, as they are in fact identical. \section1 QtObject @@ -96,8 +96,9 @@ instances of another type to be instantiated on-demand. It may be given an \c id and it has a default property which is the object type to instantiate, but no other properties may be added to it. -For example, the following QtObject has two different Component properties, -and it uses those components to dynamically construct objects at run-time: +For example, the following QtObject has two different \l Component +properties, and it uses those components to dynamically construct objects at +run-time: \code import QtQuick 2.0 |