Adding QDoc to QRenderTarget

Adding skeletal documentation to QRenderTarget

Task-number: QTBUG-46037
Change-Id: If598a8a8dd093ae7ca436572edce93303bac3634
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>

1 files changed, 24 insertions, 0 deletions

diff --git a/src/render/frontend/qrendertarget.cpp b/src/render/frontend/qrendertarget.cpp
index 349997bdb..44414e904 100644
--- a/src/render/frontend/qrendertarget.cpp
+++ b/src/render/frontend/qrendertarget.cpp
@@ -50,11 +50,24 @@ using namespace Qt3DCore;
 
 namespace Qt3DRender {
 
+/*!
+ * \class Qt3DRender::QRenderTarget
+ * \brief The QRenderTarget class encapsulates a target (usually a frame buffer
+ * object) which the renderer can render into.
+ * \since 5.7
+ * \inmodule Qt3DRender
+ */
+
+/*! \internal */
 QRenderTargetPrivate::QRenderTargetPrivate()
     : QComponentPrivate()
 {
 }
 
+/*!
+ * The constructor creates a new QRenderTarget::QRenderTarget instance with
+ * the specified \a parent.
+ */
 QRenderTarget::QRenderTarget(QNode *parent)
     : QComponent(*new QRenderTargetPrivate, parent)
 {
@@ -71,6 +84,10 @@ QRenderTarget::QRenderTarget(QRenderTargetPrivate &dd, QNode *parent)
 {
 }
 
+/*!
+ * Adds a chosen output via \a output.
+ * \param output
+ */
 void QRenderTarget::addOutput(QRenderTargetOutput *output)
 {
     Q_D(QRenderTarget);
@@ -91,6 +108,10 @@ void QRenderTarget::addOutput(QRenderTargetOutput *output)
     }
 }
 
+/*!
+ * Removes a chosen output via \a output.
+ * \param output
+ */
 void QRenderTarget::removeOutput(QRenderTargetOutput *output)
 {
     Q_D(QRenderTarget);
@@ -105,6 +126,9 @@ void QRenderTarget::removeOutput(QRenderTargetOutput *output)
     d->unregisterDestructionHelper(output);
 }
 
+/*!
+ * \return the chosen outputs.
+ */
 QVector<QRenderTargetOutput *> QRenderTarget::outputs() const
 {
     Q_D(const QRenderTarget);