aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBea Lam <bea.lam@nokia.com>2012-08-08 16:33:34 +1000
committerQt by Nokia <qt-info@nokia.com>2012-08-08 13:51:22 +0200
commit68b4a904df701a39f1d9da52104ba26a5253e636 (patch)
tree5bb6f93bd08b82698bb112b1074987cebcede50b
parent368e122556b4c77da4ec11dee52b66728feb9cdb (diff)
Fix uses of \inmodule, \inqqmlmodule and \since
Some classes and QML types were missing these or had the wrong values. Change-Id: Ic6376b8b450301f8ae0549e636f4bc2db4400f2b Reviewed-by: Chris Adams <christopher.adams@nokia.com>
-rw-r--r--src/qml/qml/qqmlcomponent.cpp1
-rw-r--r--src/qml/qml/qqmlcontext.cpp2
-rw-r--r--src/qml/qml/qqmlengine.cpp1
-rw-r--r--src/qml/qml/qqmlincubator.cpp2
-rw-r--r--src/qml/qml/qqmlpropertyvaluesource.cpp1
-rw-r--r--src/qml/qml/qqmlscriptstring.cpp2
-rw-r--r--src/qml/util/qqmlpropertymap.cpp1
-rw-r--r--src/quick/items/qquickshadereffectmesh.cpp1
-rw-r--r--src/quick/items/qquickshadereffectsource.cpp3
-rw-r--r--src/quick/util/qquickimageprovider.cpp2
10 files changed, 10 insertions, 6 deletions
diff --git a/src/qml/qml/qqmlcomponent.cpp b/src/qml/qml/qqmlcomponent.cpp
index b1715f1c70..951a7238bb 100644
--- a/src/qml/qml/qqmlcomponent.cpp
+++ b/src/qml/qml/qqmlcomponent.cpp
@@ -193,7 +193,6 @@ static inline QString buildTypeNameForDebug(const QMetaObject *metaObject)
\qmltype Component
\instantiates QQmlComponent
\ingroup qml-utility-elements
- \since 4.7
\inqmlmodule QtQuick 2
\brief Encapsulates a QML component definition
diff --git a/src/qml/qml/qqmlcontext.cpp b/src/qml/qml/qqmlcontext.cpp
index 1fa4835120..6c83433d03 100644
--- a/src/qml/qml/qqmlcontext.cpp
+++ b/src/qml/qml/qqmlcontext.cpp
@@ -65,9 +65,9 @@ QQmlContextPrivate::QQmlContextPrivate()
/*!
\class QQmlContext
- \since 4.7
\brief The QQmlContext class defines a context within a QML engine.
\mainclass
+ \inmodule QtQml
Contexts allow data to be exposed to the QML components instantiated by the
QML engine.
diff --git a/src/qml/qml/qqmlengine.cpp b/src/qml/qml/qqmlengine.cpp
index bce5579f31..90a71f997a 100644
--- a/src/qml/qml/qqmlengine.cpp
+++ b/src/qml/qml/qqmlengine.cpp
@@ -113,7 +113,6 @@ void qmlRegisterBaseTypes(const char *uri, int versionMajor, int versionMinor)
\instantiates QObject
\inqmlmodule QtQuick 2
\ingroup qml-utility-elements
- \since 4.7
\brief A basic QML type
The QtObject type is a non-visual element which contains only the
diff --git a/src/qml/qml/qqmlincubator.cpp b/src/qml/qml/qqmlincubator.cpp
index a084e9ee46..a21f5e08ef 100644
--- a/src/qml/qml/qqmlincubator.cpp
+++ b/src/qml/qml/qqmlincubator.cpp
@@ -174,6 +174,7 @@ void QQmlIncubatorPrivate::clear()
/*!
\class QQmlIncubationController
\brief QQmlIncubationController instances drive the progress of QQmlIncubators
+\inmodule QtQml
In order to behave asynchronously and not introduce stutters or freezes in an application,
the process of creating objects a QQmlIncubators must be driven only during the
@@ -402,6 +403,7 @@ void QQmlIncubationController::incubateWhile(volatile bool *flag, int msecs)
/*!
\class QQmlIncubator
\brief The QQmlIncubator class allows QML objects to be created asynchronously.
+\inmodule QtQml
Creating QML objects - like delegates in a view, or a new page in an application - can take
a noticable amount of time, especially on resource constrained mobile devices. When an
diff --git a/src/qml/qml/qqmlpropertyvaluesource.cpp b/src/qml/qml/qqmlpropertyvaluesource.cpp
index bd1ca05b81..3fb5ef8824 100644
--- a/src/qml/qml/qqmlpropertyvaluesource.cpp
+++ b/src/qml/qml/qqmlpropertyvaluesource.cpp
@@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE
/*!
\class QQmlPropertyValueSource
\brief The QQmlPropertyValueSource class is an interface for property value sources such as animations and bindings.
+ \inmodule QtQml
See \l{Property Value Sources} for information on writing custom property
value sources.
diff --git a/src/qml/qml/qqmlscriptstring.cpp b/src/qml/qml/qqmlscriptstring.cpp
index c38105d4eb..b715cb6c31 100644
--- a/src/qml/qml/qqmlscriptstring.cpp
+++ b/src/qml/qml/qqmlscriptstring.cpp
@@ -46,8 +46,8 @@ QT_BEGIN_NAMESPACE
/*!
\class QQmlScriptString
-\since 4.7
\brief The QQmlScriptString class encapsulates a script and its context.
+\inmodule QtQml
QQmlScriptString is used to create QObject properties that accept a script "assignment" from QML.
diff --git a/src/qml/util/qqmlpropertymap.cpp b/src/qml/util/qqmlpropertymap.cpp
index 37f9e3118a..e3348eb768 100644
--- a/src/qml/util/qqmlpropertymap.cpp
+++ b/src/qml/util/qqmlpropertymap.cpp
@@ -142,6 +142,7 @@ int QQmlPropertyMapMetaObject::createProperty(const char *name, const char *valu
/*!
\class QQmlPropertyMap
\brief The QQmlPropertyMap class allows you to set key-value pairs that can be used in QML bindings.
+ \inmodule QtQml
QQmlPropertyMap provides a convenient way to expose domain data to the UI layer.
The following example shows how you might declare data in C++ and then
diff --git a/src/quick/items/qquickshadereffectmesh.cpp b/src/quick/items/qquickshadereffectmesh.cpp
index 7264286fbe..c2c76439b2 100644
--- a/src/quick/items/qquickshadereffectmesh.cpp
+++ b/src/quick/items/qquickshadereffectmesh.cpp
@@ -54,6 +54,7 @@ QQuickShaderEffectMesh::QQuickShaderEffectMesh(QObject *parent)
\qmltype GridMesh
\instantiates QQuickGridMesh
\inqmlmodule QtQuick 2
+ \since QtQuick 2.0
\ingroup qtquick-effects
\brief Defines a mesh with vertices arranged in a grid
diff --git a/src/quick/items/qquickshadereffectsource.cpp b/src/quick/items/qquickshadereffectsource.cpp
index 219258b41b..d2a1ad2590 100644
--- a/src/quick/items/qquickshadereffectsource.cpp
+++ b/src/quick/items/qquickshadereffectsource.cpp
@@ -459,7 +459,8 @@ QImage QQuickShaderEffectTexture::toImage() const
/*!
\qmltype ShaderEffectSource
\instantiates QQuickShaderEffectSource
- \since 5.0
+ \inqmlmodule QtQuick 2
+ \since QtQuick 2.0
\inherits Item
\ingroup qtquick-effects
\brief Renders a QtQuick item into a texture and displays it
diff --git a/src/quick/util/qquickimageprovider.cpp b/src/quick/util/qquickimageprovider.cpp
index c6ad5acaa3..08ed8c12fa 100644
--- a/src/quick/util/qquickimageprovider.cpp
+++ b/src/quick/util/qquickimageprovider.cpp
@@ -54,7 +54,7 @@ public:
\class QQuickTextureFactory
\since 5.0
\brief The QQuickTextureFactory class provides an interface for loading custom textures from QML.
- \inmodule QtQml
+ \inmodule QtQuick
The purpose of the texture factory is to provide a placeholder for a image
data that can be converted into an OpenGL texture.