Adding QDoc to QRenderSettings

Adding skeletal documentation to QRenderSettings

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

2 files changed, 37 insertions, 1 deletions

diff --git a/src/render/frontend/qpickingsettings.cpp b/src/render/frontend/qpickingsettings.cpp
index e4c1f371f..0e152f5f1 100644
--- a/src/render/frontend/qpickingsettings.cpp
+++ b/src/render/frontend/qpickingsettings.cpp
@@ -46,7 +46,9 @@ namespace Qt3DRender {
 
 /*!
  * \class Qt3DRender::QPickingSettings
- * \brief The QPickingSettings class
+ * \brief The QPickingSettings class specifies the current framegraph to be used
+ * by the renderer and specifies whether rendering is always active or updated
+ * only on changes.
  * \since 5.7
  * \inmodule Qt3DRender
  */
diff --git a/src/render/frontend/qrendersettings.cpp b/src/render/frontend/qrendersettings.cpp
index aebf60684..715c9cc5e 100644
--- a/src/render/frontend/qrendersettings.cpp
+++ b/src/render/frontend/qrendersettings.cpp
@@ -45,6 +45,14 @@ QT_BEGIN_NAMESPACE
 
 namespace Qt3DRender {
 
+/*!
+ * \class Qt3DRender::QRenderSettings
+ * \brief The QRenderSettings class
+ * \since 5.7
+ * \inmodule Qt3DRender
+ */
+
+/*! \internal */
 QRenderSettingsPrivate::QRenderSettingsPrivate()
     : Qt3DCore::QComponentPrivate()
     , m_activeFrameGraph(nullptr)
@@ -52,6 +60,7 @@ QRenderSettingsPrivate::QRenderSettingsPrivate()
 {
 }
 
+/*! \internal */
 void QRenderSettingsPrivate::init()
 {
     Q_Q(QRenderSettings);
@@ -61,19 +70,27 @@ void QRenderSettingsPrivate::init()
                      q, SLOT(_q_onPickResultModeChanged(QPickingSettings::PickResultMode)));
 }
 
+/*! \internal */
 void QRenderSettingsPrivate::_q_onPickingMethodChanged(QPickingSettings::PickMethod pickMethod)
 {
     notifyPropertyChange("pickMethod", pickMethod);
 }
 
+/*! \internal */
 void QRenderSettingsPrivate::_q_onPickResultModeChanged(QPickingSettings::PickResultMode pickResultMode)
 {
     notifyPropertyChange("pickResultMode", pickResultMode);
 }
 
+/*!
+ * The constructor creates a new QRenderSettings::QRenderSettings instance with the
+ * specified \a parent.
+ * \param parent
+ */
 QRenderSettings::QRenderSettings(Qt3DCore::QNode *parent)
     : QRenderSettings(*new QRenderSettingsPrivate, parent) {}
 
+/*! \internal */
 QRenderSettings::QRenderSettings(QRenderSettingsPrivate &dd, Qt3DCore::QNode *parent)
     : Qt3DCore::QComponent(dd, parent)
 {
@@ -86,24 +103,37 @@ QRenderSettings::~QRenderSettings()
 {
 }
 
+/*!
+ * \return the current picking settings.
+ */
 QPickingSettings *QRenderSettings::pickingSettings()
 {
     Q_D(QRenderSettings);
     return &(d->m_pickingSettings);
 }
 
+/*!
+ * \return the current active framegraph.
+ */
 QFrameGraphNode *QRenderSettings::activeFrameGraph() const
 {
     Q_D(const QRenderSettings);
     return d->m_activeFrameGraph;
 }
 
+/*!
+ * \return the current render policy
+ */
 QRenderSettings::RenderPolicy QRenderSettings::renderPolicy() const
 {
     Q_D(const QRenderSettings);
     return d->m_renderPolicy;
 }
 
+/*!
+ * Sets the active framegraph to \a activeFrameGraph.
+ * \param activeFrameGraph
+ */
 void QRenderSettings::setActiveFrameGraph(QFrameGraphNode *activeFrameGraph)
 {
     Q_D(QRenderSettings);
@@ -125,6 +155,10 @@ void QRenderSettings::setActiveFrameGraph(QFrameGraphNode *activeFrameGraph)
     emit activeFrameGraphChanged(activeFrameGraph);
 }
 
+/*!
+ * Sets the render policy to \a renderPolicy.
+ * \param renderPolicy
+ */
 void QRenderSettings::setRenderPolicy(QRenderSettings::RenderPolicy renderPolicy)
 {
     Q_D(QRenderSettings);