aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml
diff options
context:
space:
mode:
authorBea Lam <bea.lam@nokia.com>2012-08-27 17:04:17 +1000
committerQt by Nokia <qt-info@nokia.com>2012-08-28 04:32:48 +0200
commitc5e46a63b2dac24e411b904019ef9e87a832791b (patch)
treeeb20cfd12dcef0d17fb84ee5005418b19cf0b5ff /src/qml
parent4a4a08d61a9771b5f49d7377b48d821075df3d97 (diff)
Fix various doc errors
Also restore the main module "reference documentation" links added in 0e0f46c01cf6a183996d36c31987ca4a46b50bd9 Change-Id: I421f5a17e2946a2569537d8ba8a021f219aaf75a Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
Diffstat (limited to 'src/qml')
-rw-r--r--src/qml/doc/src/modules/cppplugins.qdoc4
-rw-r--r--src/qml/doc/src/qmltypereference.qdoc2
-rw-r--r--src/qml/doc/src/qtqml-cpp.qdoc2
-rw-r--r--src/qml/doc/src/qtqml.qdoc19
-rw-r--r--src/qml/doc/src/syntax/imports.qdoc16
-rw-r--r--src/qml/qml/qqmlengine.cpp3
-rw-r--r--src/qml/qml/qqmlextensionplugin.cpp6
7 files changed, 31 insertions, 21 deletions
diff --git a/src/qml/doc/src/modules/cppplugins.qdoc b/src/qml/doc/src/modules/cppplugins.qdoc
index df4156d67a..887e7ccd0c 100644
--- a/src/qml/doc/src/modules/cppplugins.qdoc
+++ b/src/qml/doc/src/modules/cppplugins.qdoc
@@ -53,7 +53,7 @@
by the plugin
\endlist
\li Write a project file for the plugin
- \li Create a \l{Adding Module Metadata with a qmldir file}{qmldir file} to
+ \li Create a \l{Module Definition qmldir Files}{qmldir file} to
describe the plugin
\endlist
@@ -105,7 +105,7 @@
SOURCES += qexampleqmlplugin.cpp
\endcode
- Finally, a \l{Adding Module Metadata with a qmldir file}{qmldir file} is required
+ Finally, a \l{Module Definition qmldir Files}{qmldir file} is required
in the \c com/nokia/TimeExample directory to describe the plugin and the types that it
exports. The plugin includes a \c Clock.qml file along with the \c qmlqtimeexampleplugin
that is built by the project (as shown above in the \c .pro file) so both of these
diff --git a/src/qml/doc/src/qmltypereference.qdoc b/src/qml/doc/src/qmltypereference.qdoc
index 4e4c2c546c..7308350b07 100644
--- a/src/qml/doc/src/qmltypereference.qdoc
+++ b/src/qml/doc/src/qmltypereference.qdoc
@@ -292,7 +292,7 @@ is automatically converted into a QSizeF value.
The \c rect type refers to a value with \c x, \c y, \c width and \c height attributes.
For example, to read the \c width and \c height values of the \l Item
-\l {Item::}{childrenRect} rect-type type property:
+\l {Item::childrenRect.x}{childrenRect} rect-type type property:
\qml
Rectangle {
diff --git a/src/qml/doc/src/qtqml-cpp.qdoc b/src/qml/doc/src/qtqml-cpp.qdoc
index e36ff77752..20dcb3a6f0 100644
--- a/src/qml/doc/src/qtqml-cpp.qdoc
+++ b/src/qml/doc/src/qtqml-cpp.qdoc
@@ -26,7 +26,7 @@
****************************************************************************/
/*!
\module QtQml
-\title Qt QML - C++ Classes
+\title Qt QML Module - C++ Classes
\brief The C++ API provided by the Qt QML module
To include the definitions of the module's classes, use the
diff --git a/src/qml/doc/src/qtqml.qdoc b/src/qml/doc/src/qtqml.qdoc
index 35667034d0..8baef1d5bc 100644
--- a/src/qml/doc/src/qtqml.qdoc
+++ b/src/qml/doc/src/qtqml.qdoc
@@ -168,12 +168,21 @@ for an introduction to writing QML applications.
\section1 Reference Documentation
+Additional Qt QML information:
\list
-\li \l{QML Types Provided By The QtQml Module}{Qt QML - QML Type Reference}
-\li \l{Qt QML - C++ Classes}
-\li \l{Qt Quick} module documentation
-\li \l{QML Application Developer Resources} - information for application development with QML and Qt Quick
-\li \l{Qt QML Release Notes}
+\li \l{Qt QML Module - C++ Classes} - the C++ API provided by the
+ Qt QML module
+\li \l{Qt QML Release Notes} - list of changes and
+ additions in the Qt QML module
+\endlist
+
+Further information for writing QML applications:
+\list
+\li \l{QML Application Developer Resources}
+ - essential information for application development with QML and Qt Quick
+\li \l{Qt Quick} - documentation for the Qt Quick module, which provides a
+ visual canvas, an animation framework, model/view components and more for
+ building fluid user interfaces and applications with QML
\endlist
*/
diff --git a/src/qml/doc/src/syntax/imports.qdoc b/src/qml/doc/src/syntax/imports.qdoc
index 51c80ea6c8..e9e7cd0372 100644
--- a/src/qml/doc/src/syntax/imports.qdoc
+++ b/src/qml/doc/src/syntax/imports.qdoc
@@ -48,9 +48,9 @@ The most common type of import is a module import. Clients can import
types and JavaScript resources into a given namespace.
The generic form of a module import is as follows:
-\qml
+\code
import <ModuleIdentifier> <Version.Number> [as <Qualifier>]
-\endqml
+\endcode
\list
\li The \c <ModuleIdentifier> is an identifier specified in dotted URI
@@ -68,9 +68,9 @@ import <ModuleIdentifier> <Version.Number> [as <Qualifier>]
\endlist
An example of an unqualified module import is as follows:
-\qml
+\code
import QtQuick 2.0
-\endqml
+\endcode
This import allows the use of all of the types provided by the \c QtQuick
module without needing to specify a qualifier. For example, the client code to
@@ -87,9 +87,9 @@ Rectangle {
\endqml
An example of a qualified module import is as follows:
-\qml
+\code
import QtQuick 2.0 as Quick
-\endqml
+\endcode
This import allows multiple modules which provide conflicting type names to be
imported at the same time, however since each usage of a type provided by a
@@ -219,9 +219,9 @@ JavaScript resources may be imported directly in a QML document. Every
JavaScript resource must have an identifier by which it is accessed.
The generic form of a JavaScript resource import is as follows:
-\qml
+\code
import "<JavaScriptFile>" as <Identifier>
-\endqml
+\endcode
Note that the \c <Identifier> must be unique within a QML document, unlike the
local namespace qualifier which can be applied to module imports.
diff --git a/src/qml/qml/qqmlengine.cpp b/src/qml/qml/qqmlengine.cpp
index b3952a787a..be207089e2 100644
--- a/src/qml/qml/qqmlengine.cpp
+++ b/src/qml/qml/qqmlengine.cpp
@@ -217,7 +217,8 @@ void QQmlEnginePrivate::defineQtQuick2Module()
\value Pixmap The Image Provider provides QPixmap images.
The QQuickImageProvider::requestPixmap() method will be called for all image requests.
\value Texture The Image Provider provides QSGTextureProvider based images.
- The QQuickImageProvider::requestTexture() method will be called for all image requests. \omitvalue
+ The QQuickImageProvider::requestTexture() method will be called for all image requests.
+ \omitvalue Invalid
*/
/*!
diff --git a/src/qml/qml/qqmlextensionplugin.cpp b/src/qml/qml/qqmlextensionplugin.cpp
index 8ccbb88dc2..f75b2bdab2 100644
--- a/src/qml/qml/qqmlextensionplugin.cpp
+++ b/src/qml/qml/qqmlextensionplugin.cpp
@@ -61,7 +61,7 @@ QT_BEGIN_NAMESPACE
\li Subclass QQmlExtensionPlugin, implement registerTypes() method
to register types using qmlRegisterType(), and export the class using the Q_EXPORT_PLUGIN2() macro
\li Write an appropriate project file for the plugin
- \li Create a \l{Adding Module Metadata with a qmldir file}{qmldir file} to describe the plugin
+ \li Create a \l{Module Definition qmldir Files}{qmldir file} to describe the plugin
\endlist
QML extension plugins can be used to provide either application-specific or
@@ -105,7 +105,7 @@ QT_BEGIN_NAMESPACE
...
\endcode
- Finally, a \l{Adding Module Metadata with a qmldir file}{qmldir file} is required in the \c com/nokia/TimeExample directory
+ Finally, a \l{Module Definition qmldir Files}{qmldir file} is required in the \c com/nokia/TimeExample directory
that describes the plugin. This directory includes a \c Clock.qml file that
should be bundled with the plugin, so it needs to be specified in the \c qmldir
file:
@@ -119,7 +119,7 @@ QT_BEGIN_NAMESPACE
The full source code is available in the \l {qml/cppextensions/plugins}{plugins example}.
- The \l {Tutorial: Extending QML with C++} also contains a chapter
+ The \l {Writing QML Extensions with C++} tutorial also contains a chapter
on creating QML plugins.
Note that the QtQuick 1 version is called QDeclarativeExtensionPlugin.