Fix uses of \inmodule, \inqqmlmodule and \since
authorBea Lam <bea.lam@nokia.com>
Wed, 8 Aug 2012 06:33:34 +0000 (16:33 +1000)
committerQt by Nokia <qt-info@nokia.com>
Wed, 8 Aug 2012 11:51:22 +0000 (13:51 +0200)
Some classes and QML types were missing these or had the wrong values.

Change-Id: Ic6376b8b450301f8ae0549e636f4bc2db4400f2b
Reviewed-by: Chris Adams <christopher.adams@nokia.com>
src/qml/qml/qqmlcomponent.cpp
src/qml/qml/qqmlcontext.cpp
src/qml/qml/qqmlengine.cpp
src/qml/qml/qqmlincubator.cpp
src/qml/qml/qqmlpropertyvaluesource.cpp
src/qml/qml/qqmlscriptstring.cpp
src/qml/util/qqmlpropertymap.cpp
src/quick/items/qquickshadereffectmesh.cpp
src/quick/items/qquickshadereffectsource.cpp
src/quick/util/qquickimageprovider.cpp

index b1715f1..951a723 100644 (file)
@@ -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
 
index 1fa4835..6c83433 100644 (file)
@@ -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.
index bce5579..90a71f9 100644 (file)
@@ -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
index a084e9e..a21f5e0 100644 (file)
@@ -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
index bd1ca05..3fb5ef8 100644 (file)
@@ -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.
index c38105d..b715cb6 100644 (file)
@@ -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.
 
index 37f9e31..e3348eb 100644 (file)
@@ -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
index 7264286..c2c7643 100644 (file)
@@ -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
 
index 219258b..d2a1ad2 100644 (file)
@@ -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
index c6ad5ac..08ed8c1 100644 (file)
@@ -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.