Doc: Modularized documentation.

-moved API documentation in QML files
-moved snippets, images, and qdoc files to src/effects/doc
-deleted old .pri and .qdocconf files
-fixed relative paths

Change-Id: I4e757e707b5f93a215506f8c2cbb7eb1f2321d4c
Reviewed-by: Geir Vattekar <geir.vattekar@digia.com>

1 files changed, 68 insertions, 0 deletions

diff --git a/src/effects/Desaturate.qml b/src/effects/Desaturate.qml
index a51cf0b..fb2ec3b 100644
--- a/src/effects/Desaturate.qml
+++ b/src/effects/Desaturate.qml
@@ -41,10 +41,78 @@
 import QtQuick 2.0
 import "private"
 
+/*!
+    \qmltype Desaturate
+    \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-color
+    \brief Reduces the saturation of the colors.
+
+   Desaturated pixel values are calculated as averages of the original RGB
+   component values of the source item.
+
+    \table
+    \header
+        \li Source
+        \li Effect applied
+    \row
+        \li \image Original_bug.png
+        \li \image Desaturate_bug.png
+    \endtable
+
+    \section1 Example
+
+    The following example shows how to apply the effect.
+    \snippet Desaturate-example.qml example
+
+*/
 Item {
     id: rootItem
+
+    /*!
+        This property defines the source item that provides the source pixels to
+        the effect.
+    */
     property variant source
+
+    /*!
+        This property defines how much the source colors are desaturated.
+
+        The value ranges from 0.0 (no change) to 1.0 (desaturated). By default,
+        the property is set to \c 0.0 (no chnage).
+
+        \table
+        \header
+        \li Output examples with different desaturation values
+        \li
+        \li
+        \row
+            \li \image Desaturate_desaturation1.png
+            \li \image Desaturate_desaturation2.png
+            \li \image Desaturate_desaturation3.png
+        \row
+            \li \b { desaturation: 0.0 }
+            \li \b { desaturation: 0.5 }
+            \li \b { desaturation: 1.0 }
+        \endtable
+    */
     property real desaturation: 0.0
+
+    /*!
+        This property allows the effect output pixels to be cached in order to
+        improve the rendering performance.
+
+        Every time the source or effect properties are changed, the pixels in
+        the cache must be updated. Memory consumption is increased, because an
+        extra buffer of memory is required for storing the effect output.
+
+        It is recommended to disable the cache when the source or the effect
+        properties are animated.
+
+        By default, the property is set to \c false.
+
+    */
     property bool cached: false
 
     SourceProxy {