diff options
author | Nico Vertriest <nico.vertriest@digia.com> | 2015-08-03 13:47:11 +0200 |
---|---|---|
committer | Nico Vertriest <nico.vertriest@digia.com> | 2015-11-02 10:47:23 +0000 |
commit | 65197439337ddf9efcfcdbc3223573858e5fe611 (patch) | |
tree | 1a4e2aa972e97058b1bab8e0c67df64dcacf878c /src/quick | |
parent | 5c53861cced2d40490e4c7bfc202aadc532df4c2 (diff) |
Doc: added documentation to undocumented functions
Task-number: QTBUG-36985
Change-Id: I219375d405fbfb53611c0138698e955d9cd5d821
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Topi Reiniƶ <topi.reinio@digia.com>
Diffstat (limited to 'src/quick')
-rw-r--r-- | src/quick/items/qquicktextdocument.cpp | 7 | ||||
-rw-r--r-- | src/quick/scenegraph/coreapi/qsgmaterial.cpp | 8 | ||||
-rw-r--r-- | src/quick/scenegraph/util/qsgtextureprovider.cpp | 8 | ||||
-rw-r--r-- | src/quick/util/qquickimageprovider.cpp | 21 |
4 files changed, 43 insertions, 1 deletions
diff --git a/src/quick/items/qquicktextdocument.cpp b/src/quick/items/qquicktextdocument.cpp index b34ae24461..fa89d43b86 100644 --- a/src/quick/items/qquicktextdocument.cpp +++ b/src/quick/items/qquicktextdocument.cpp @@ -63,6 +63,10 @@ public: QPointer<QTextDocument> document; }; +/*! + Constructs a QQuickTextDocument object with + \a parent as the parent object. +*/ QQuickTextDocument::QQuickTextDocument(QQuickItem *parent) : QObject(*(new QQuickTextDocumentPrivate), parent) { @@ -72,6 +76,9 @@ QQuickTextDocument::QQuickTextDocument(QQuickItem *parent) d->document = QPointer<QTextDocument>(qobject_cast<QQuickTextEdit*>(parent)->d_func()->document); } +/*! + Returns a pointer to the QTextDocument object. +*/ QTextDocument* QQuickTextDocument::textDocument() const { Q_D(const QQuickTextDocument); diff --git a/src/quick/scenegraph/coreapi/qsgmaterial.cpp b/src/quick/scenegraph/coreapi/qsgmaterial.cpp index c68c0b93d2..367c0b1ee5 100644 --- a/src/quick/scenegraph/coreapi/qsgmaterial.cpp +++ b/src/quick/scenegraph/coreapi/qsgmaterial.cpp @@ -188,6 +188,9 @@ QSGMaterialShader::QSGMaterialShader() { } +/*! + \internal + */ QSGMaterialShader::QSGMaterialShader(QSGMaterialShaderPrivate &dd) : d_ptr(&dd) { @@ -463,7 +466,10 @@ QMatrix4x4 QSGMaterialShader::RenderState::combinedMatrix() const Q_ASSERT(m_data); return static_cast<const QSGRenderer *>(m_data)->currentCombinedMatrix(); } - +/*! + Returns the ratio between physical pixels and device-independent pixels + to be used for rendering. +*/ float QSGMaterialShader::RenderState::devicePixelRatio() const { Q_ASSERT(m_data); diff --git a/src/quick/scenegraph/util/qsgtextureprovider.cpp b/src/quick/scenegraph/util/qsgtextureprovider.cpp index b9f9bde476..2d05e736fe 100644 --- a/src/quick/scenegraph/util/qsgtextureprovider.cpp +++ b/src/quick/scenegraph/util/qsgtextureprovider.cpp @@ -44,7 +44,15 @@ QT_BEGIN_NAMESPACE \sa {Scene Graph - Two Texture Providers} */ +/*! + \fn QSGTexture *QSGTextureProvider::texture(); + Returns a pointer to the texture object. + */ +/*! + \fn void QSGTextureProvider::textureChanged(); + This signal is emitted when the texture changes. + */ QT_END_NAMESPACE diff --git a/src/quick/util/qquickimageprovider.cpp b/src/quick/util/qquickimageprovider.cpp index a231209cd0..6038967e18 100644 --- a/src/quick/util/qquickimageprovider.cpp +++ b/src/quick/util/qquickimageprovider.cpp @@ -365,5 +365,26 @@ QQuickTextureFactory *QQuickImageProvider::requestTexture(const QString &id, QSi return 0; } +/*! + \fn QImage QQuickImageProvider::requestImage(const QString &id, QSize *size, const QSize& requestedSize, bool requestedAutoTransform); + + \internal + For future reference. +*/ + +/*! + \fn QPixmap QQuickImageProvider::requestPixmap(const QString &id, QSize *size, const QSize& requestedSize, bool requestedAutoTransform); + + \internal + For future reference. +*/ + +/*! + \fn QQuickTextureFactory *QQuickImageProvider::requestTexture(const QString &id, QSize *size, const QSize &requestedSize, bool requestedAutoTransform); + + \internal + For future reference. +*/ + QT_END_NAMESPACE |