From 2f0dd9a147d74bb5df58c6f402b50b35313ae3ff Mon Sep 17 00:00:00 2001
From: Miikka Heikkinen <miikka.heikkinen@qt.io>
Date: Mon, 5 Sep 2016 14:02:03 +0300
Subject: Update QFilterKey docs
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Change-Id: Id6bb471e11de2bf8b33cec603d382f079d0b0e79
Reviewed-by: Antti Määttä <antti.maatta@qt.io>
Reviewed-by: Paul Lemire <paul.lemire@kdab.com>
---
 src/render/materialsystem/qfilterkey.cpp | 40 +++++++++++++++++++-------------
 1 file changed, 24 insertions(+), 16 deletions(-)

diff --git a/src/render/materialsystem/qfilterkey.cpp b/src/render/materialsystem/qfilterkey.cpp
index d4bc26515..547c56d26 100644
--- a/src/render/materialsystem/qfilterkey.cpp
+++ b/src/render/materialsystem/qfilterkey.cpp
@@ -55,8 +55,12 @@ QFilterKeyPrivate::QFilterKeyPrivate()
 /*!
     \class Qt3DRender::QFilterKey
     \inmodule Qt3DRender
+    \inherits Qt3DCore::QNode
     \since 5.5
-    \brief The QFilterKey class provides storage for filter keys and their values
+    \brief The QFilterKey class provides storage for filter keys and their values.
+
+    Filter keys are used by QTechnique and QRenderPass to specify at which stage of rendering the
+    technique or the render pass is used.
 */
 
 /*!
@@ -65,18 +69,18 @@ QFilterKeyPrivate::QFilterKeyPrivate()
     \inherits Node
     \inqmlmodule Qt3D.Render
     \since 5.5
-    \brief For storing filter keys and their value
+    \brief Stores filter keys and their values.
+
+    A FilterKey is a storage type for filter key and value pair.
+    Filter keys are used by Technique and RenderPass to specify at which stage of rendering the
+    technique or the render pass is used.
 */
 
-/*!
-  The constructor creates a new QFilterKey under \a parent.
- */
 QFilterKey::QFilterKey(QNode *parent)
     : QNode(*new QFilterKeyPrivate, parent)
 {
 }
 
-/*! \internal */
 QFilterKey::~QFilterKey()
 {
 }
@@ -100,13 +104,15 @@ void QFilterKey::setName(const QString &name)
 }
 
 /*!
-  \property QFilterKey::value
-    Specifies the value of the filter key
+    \property QFilterKey::value
+
+    Holds the value of the filter key.
 */
 
 /*!
-  \qmlproperty variant Qt3D.Render::Annotation::value
-    Specifies the value of the filter key
+    \qmlproperty variant FilterKey::value
+
+    Holds the value of the filter key.
 */
 
 QVariant QFilterKey::value() const
@@ -116,14 +122,16 @@ QVariant QFilterKey::value() const
 }
 
 /*!
-  \property QFilterKey::name
-    Specifies the name of the filter key
- */
+    \property QFilterKey::name
+
+    Holds the name of the filter key.
+*/
 
 /*!
-  \qmlproperty string Qt3D.Render::Annotation::name
-    Specifies the name of the filter key
- */
+    \qmlproperty string FilterKey::name
+
+    Holds the name of the filter key.
+*/
 
 QString QFilterKey::name() const
 {
-- 
cgit v1.2.3