summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNico Vertriest <nico.vertriest@qt.io>2017-05-26 12:05:50 +0200
committerTony Sarajärvi <tony.sarajarvi@qt.io>2017-10-20 16:05:15 +0000
commitc0c3c217538cc17e6071e771d8ec54c445620095 (patch)
tree2923fc95a773f776528d07c8a4dde060ebd4ada6
parent98831cad7eea13070212d341a3c779ceccb010d8 (diff)
Doc: add doc to undocumented classes
Change-Id: I342a74f6605d7e6a9ac6f07af21dc8f7fd80c3ce Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io> Reviewed-by: Laszlo Agocs <laszlo.agocs@qt.io>
-rw-r--r--src/render/framegraph/qbuffercapture.cpp5
-rw-r--r--src/render/framegraph/qframegraphnodecreatedchange.cpp6
-rw-r--r--src/render/texture/qpaintedtextureimage.cpp2
-rw-r--r--src/render/texture/qtexture.cpp5
-rw-r--r--src/render/texture/qtexturegenerator.cpp4
5 files changed, 21 insertions, 1 deletions
diff --git a/src/render/framegraph/qbuffercapture.cpp b/src/render/framegraph/qbuffercapture.cpp
index 602ad5d6d..d1d301077 100644
--- a/src/render/framegraph/qbuffercapture.cpp
+++ b/src/render/framegraph/qbuffercapture.cpp
@@ -58,6 +58,11 @@ QBufferCapturePrivate::QBufferCapturePrivate()
}
+/*!
+ \class Qt3DRender::QBufferCapture
+ \inmodule Qt3DRender
+ \brief Exchanges buffer data between GPU and CPU.
+*/
QBufferCapture::QBufferCapture(Qt3DCore::QNode *parent)
: QFrameGraphNode(*new QBufferCapturePrivate, parent)
{
diff --git a/src/render/framegraph/qframegraphnodecreatedchange.cpp b/src/render/framegraph/qframegraphnodecreatedchange.cpp
index 1f04a099d..ef51d5228 100644
--- a/src/render/framegraph/qframegraphnodecreatedchange.cpp
+++ b/src/render/framegraph/qframegraphnodecreatedchange.cpp
@@ -48,6 +48,12 @@ QFrameGraphNodeCreatedChangeBasePrivate::QFrameGraphNodeCreatedChangeBasePrivate
{
}
+/*!
+ \class Qt3DRender::QFrameGraphNodeCreatedChangeBase
+ \inmodule Qt3DRender
+
+ \brief A base class for changes in the FrameGraphNode.
+*/
QFrameGraphNodeCreatedChangeBase::QFrameGraphNodeCreatedChangeBase(const QFrameGraphNode *node)
: Qt3DCore::QNodeCreatedChangeBase(*new QFrameGraphNodeCreatedChangeBasePrivate(node), node)
{
diff --git a/src/render/texture/qpaintedtextureimage.cpp b/src/render/texture/qpaintedtextureimage.cpp
index db03b26b9..8bd9fb844 100644
--- a/src/render/texture/qpaintedtextureimage.cpp
+++ b/src/render/texture/qpaintedtextureimage.cpp
@@ -51,7 +51,7 @@ namespace Qt3DRender {
\class Qt3DRender::QPaintedTextureImage
\inmodule Qt3DRender
\since 5.8
- \brief A QAbstractTextureImage that can be written through a QPainter
+ \brief A QAbstractTextureImage that can be written through a QPainter.
A QPaintedTextureImage provides a way to specify a texture image
(and thus an OpenGL texture) through a QPainter. The width and height of the
diff --git a/src/render/texture/qtexture.cpp b/src/render/texture/qtexture.cpp
index 20e046ebc..37a697f2e 100644
--- a/src/render/texture/qtexture.cpp
+++ b/src/render/texture/qtexture.cpp
@@ -908,6 +908,11 @@ void QTextureLoaderPrivate::updateGenerator()
}
/*!
+ \class Qt3DRender::QTextureLoader
+ \inmodule Qt3DRender
+ \brief Handles the texture loading and setting the texture's properties.
+*/
+/*!
* Constructs a new Qt3DRender::QTextureLoader instance with \a parent as parent.
*
* Note that by default, if not contradicted by the file metadata, the loaded texture
diff --git a/src/render/texture/qtexturegenerator.cpp b/src/render/texture/qtexturegenerator.cpp
index 32b785128..78b65f303 100644
--- a/src/render/texture/qtexturegenerator.cpp
+++ b/src/render/texture/qtexturegenerator.cpp
@@ -43,6 +43,10 @@ QT_BEGIN_NAMESPACE
namespace Qt3DRender {
+/*! class Qt3DRender::QTextureGenerator
+ \inmodule Qt3DRender
+ \brief Generates the necessary information to create an OpenGL texture image.
+*/
QTextureGenerator::~QTextureGenerator()
{
}