Doc: added documentation to undocumented methods

Task-number: QTBUG-36985
Change-Id: Idc6f7961f4f02f66dc3d4a8e5d09dd15d43b7757
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>

diff --git a/src/qml/qml/qqmlabstracturlinterceptor.cpp b/src/qml/qml/qqmlabstracturlinterceptor.cpp
index e64b33b181a3ceddbc9a44a27912e2534516cb0f..cb57bc2146e464cc74351e41591d0546219ffc0e 100644 (file)
--- a/src/qml/qml/qqmlabstracturlinterceptor.cpp
+++ b/src/qml/qml/qqmlabstracturlinterceptor.cpp
@@ -58,7 +58,7 @@
  To implement support for a custom networked scheme, see setNetworkAccessManagerFactory.
 */
 
-/*
+/*!
  \enum QQmlAbstractUrlInterceptor::DataType
 
  Specifies where URL interception is taking place.

diff --git a/src/qml/qml/qqmlengine.cpp b/src/qml/qml/qqmlengine.cpp
index 392cbe9371da57d5aca544860f2d589e3da9574e..ffc890a2cf625733e8bbc3b392ea9a0b7b2e6b7a 100644 (file)
--- a/src/qml/qml/qqmlengine.cpp
+++ b/src/qml/qml/qqmlengine.cpp
@@ -260,6 +260,18 @@ void QQmlEnginePrivate::activateDesignerMode()
         on producing the image without blocking the main thread.
 */
 
+/*!
+    \fn QQmlImageProviderBase::imageType() const
+
+    Implement this method to return the image type supported by this image provider.
+*/
+
+/*!
+    \fn QQmlImageProviderBase::flags() const
+
+    Implement this to return the properties of this image provider.
+*/
+
 /*! \internal */
 QQmlImageProviderBase::QQmlImageProviderBase()
 {
@@ -1354,6 +1366,9 @@ QQmlEngine::ObjectOwnership QQmlEngine::objectOwnership(QObject *object)
         return ddata->indestructible?CppOwnership:JavaScriptOwnership;
 }
 
+/*!
+   \reimp
+*/
 bool QQmlEngine::event(QEvent *e)
 {
     Q_D(QQmlEngine);

diff --git a/src/qml/qml/qqmlfileselector.cpp b/src/qml/qml/qqmlfileselector.cpp
index 3ee7bb304013033448c864f28af3e6d5ac2c7048..8597e8a5c74a10e6cf5e98f8095cad80cc4eb5b6 100644 (file)
--- a/src/qml/qml/qqmlfileselector.cpp
+++ b/src/qml/qml/qqmlfileselector.cpp
@@ -102,6 +102,9 @@ QQmlFileSelector::QQmlFileSelector(QQmlEngine* engine, QObject* parent)
     d->engine->setUrlInterceptor(d->myInstance.data());
 }
 
+/*!
+   Destroys the QQmlFileSelector object.
+*/
 QQmlFileSelector::~QQmlFileSelector()
 {
     Q_D(QQmlFileSelector);

diff --git a/src/quick/items/qquickframebufferobject.cpp b/src/quick/items/qquickframebufferobject.cpp
index c3e5b97bafda6a6dc686b5ae32ddb4d318ba07e9..6031315b90424a498a45d7a2c7fd6580009c0c50 100644 (file)
--- a/src/quick/items/qquickframebufferobject.cpp
+++ b/src/quick/items/qquickframebufferobject.cpp
@@ -298,11 +298,17 @@ QSGNode *QQuickFramebufferObject::updatePaintNode(QSGNode *node, UpdatePaintNode
     return n;
 }
 
+/*!
+   \reimp
+*/
 bool QQuickFramebufferObject::isTextureProvider() const
 {
     return true;
 }
 
+/*!
+   \reimp
+*/
 QSGTextureProvider *QQuickFramebufferObject::textureProvider() const
 {
     Q_D(const QQuickFramebufferObject);
@@ -316,6 +322,9 @@ QSGTextureProvider *QQuickFramebufferObject::textureProvider() const
     return d->node;
 }
 
+/*!
+   \reimp
+*/
 void QQuickFramebufferObject::releaseResources()
 {
     // When release resources is called on the GUI thread, we only need to

diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp
index 3d0f550d14585e837ca227f1f4016081c78702b4..5fd18822165441e02f88e001f1a8b2056cea61b2 100644 (file)
--- a/src/quick/items/qquickitem.cpp
+++ b/src/quick/items/qquickitem.cpp
@@ -4237,7 +4237,6 @@ void QQuickItem::mapToItem(QQmlV4Function *args) const
 
 /*!
     \qmlmethod QtQuick::Item::forceActiveFocus()
-    \overload
 
     Forces active focus on the item.
 
@@ -4250,6 +4249,18 @@ void QQuickItem::mapToItem(QQmlV4Function *args) const
 
     \sa activeFocus
 */
+/*!
+    Forces active focus on the item.
+
+    This method sets focus on the item and ensures that all ancestor
+    FocusScope objects in the object hierarchy are also given \l focus.
+
+    The reason for the focus change will be \l [CPP] Qt::OtherFocusReason. Use
+    the overloaded method to specify the focus reason to enable better
+    handling of the focus change.
+
+    \sa activeFocus
+*/
 void QQuickItem::forceActiveFocus()
 {
     forceActiveFocus(Qt::OtherFocusReason);
@@ -4257,7 +4268,19 @@ void QQuickItem::forceActiveFocus()
 
 /*!
     \qmlmethod QtQuick::Item::forceActiveFocus(Qt::FocusReason reason)
+    \overload
+
+    Forces active focus on the item with the given \a reason.
+
+    This method sets focus on the item and ensures that all ancestor
+    FocusScope objects in the object hierarchy are also given \l focus.
 
+    \since 5.1
+
+    \sa activeFocus, Qt::FocusReason
+*/
+/*!
+    \overload
     Forces active focus on the item with the given \a reason.
 
     This method sets focus on the item and ensures that all ancestor

diff --git a/src/quick/items/qquickpainteditem.cpp b/src/quick/items/qquickpainteditem.cpp
index b3e4906c41a3aeeb08d68245e581291126e97925..8d93c577ab1cc0db49cd031bc5ad638856c6fe7a 100644 (file)
--- a/src/quick/items/qquickpainteditem.cpp
+++ b/src/quick/items/qquickpainteditem.cpp
@@ -549,6 +549,9 @@ QSGNode *QQuickPaintedItem::updatePaintNode(QSGNode *oldNode, UpdatePaintNodeDat
     return node;
 }
 
+/*!
+   \reimp
+*/
 void QQuickPaintedItem::releaseResources()
 {
     Q_D(QQuickPaintedItem);
@@ -567,11 +570,17 @@ void QQuickPaintedItem::invalidateSceneGraph()
     d->node = 0; // Managed by the scene graph, just clear the pointer
 }
 
+/*!
+   \reimp
+*/
 bool QQuickPaintedItem::isTextureProvider() const
 {
     return true;
 }
 
+/*!
+   \reimp
+*/
 QSGTextureProvider *QQuickPaintedItem::textureProvider() const
 {
     Q_D(const QQuickPaintedItem);

diff --git a/src/quick/items/qquickrendercontrol.cpp b/src/quick/items/qquickrendercontrol.cpp
index fd4787be98a886ba96f31d7ea28c1e52bd759fdb..6b0b9c3a0681dc4d25e143a7c29285a5fd46c713 100644 (file)
--- a/src/quick/items/qquickrendercontrol.cpp
+++ b/src/quick/items/qquickrendercontrol.cpp
@@ -141,6 +141,10 @@ void QQuickRenderControlPrivate::cleanup()
     sg = 0;
 }
 
+/*!
+   Constructs a QQuickRenderControl object, with parent
+   object \a parent.
+*/
 QQuickRenderControl::QQuickRenderControl(QObject *parent)
     : QObject(*(new QQuickRenderControlPrivate), parent)
 {