diff options
author | Nico Vertriest <nico.vertriest@digia.com> | 2015-07-30 12:33:32 +0200 |
---|---|---|
committer | Nico Vertriest <nico.vertriest@digia.com> | 2015-08-04 12:15:41 +0000 |
commit | 372804f1f64918e281a29cd2f849f7e1b1488eee (patch) | |
tree | e7707c00c3e002276ed734508561fd39bbb7d81f | |
parent | d296ebfe6585010a38db0e3043ef5ceaa6a30883 (diff) |
Doc: added documentation to undocumented methods
Task-number: QTBUG-36985
Change-Id: Idc6f7961f4f02f66dc3d4a8e5d09dd15d43b7757
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
-rw-r--r-- | src/qml/qml/qqmlabstracturlinterceptor.cpp | 2 | ||||
-rw-r--r-- | src/qml/qml/qqmlengine.cpp | 15 | ||||
-rw-r--r-- | src/qml/qml/qqmlfileselector.cpp | 3 | ||||
-rw-r--r-- | src/quick/items/qquickframebufferobject.cpp | 9 | ||||
-rw-r--r-- | src/quick/items/qquickitem.cpp | 25 | ||||
-rw-r--r-- | src/quick/items/qquickpainteditem.cpp | 9 | ||||
-rw-r--r-- | src/quick/items/qquickrendercontrol.cpp | 4 |
7 files changed, 65 insertions, 2 deletions
diff --git a/src/qml/qml/qqmlabstracturlinterceptor.cpp b/src/qml/qml/qqmlabstracturlinterceptor.cpp index e64b33b181..cb57bc2146 100644 --- 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 392cbe9371..ffc890a2cf 100644 --- 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 3ee7bb3040..8597e8a5c7 100644 --- 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 c3e5b97baf..6031315b90 100644 --- 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 3d0f550d14..5fd1882216 100644 --- 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 b3e4906c41..8d93c577ab 100644 --- 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 fd4787be98..6b0b9c3a06 100644 --- 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) { |