Doc: Grouped the effects and added an overview page for the effects.

Groups:
qtgraphicaleffects-blend
qtgraphicaleffects-color
qtgraphicaleffects-gradient
qtgraphicaleffects-distortion
qtgraphicaleffects-drop-shadow
qtgraphicaleffects-blur
qtgraphicaleffects-motion-blur
qtgraphicaleffects-glow
qtgraphicaleffects-mask

Change-Id: I5ffbbcc2fed1793af3de7c50b13ffb26b9e415cb
Reviewed-by: Michalina Ziemba <michalina.ziemba@nokia.com>
Reviewed-by: Marko Niemelä <marko.a.niemela@nokia.com>

26 files changed, 100 insertions, 0 deletions

diff --git a/doc/src/overview-graphicaleffects.qdoc b/doc/src/overview-graphicaleffects.qdoc
new file mode 100644
index 0000000..7ee94ec
--- /dev/null
+++ b/doc/src/overview-graphicaleffects.qdoc
@@ -0,0 +1,75 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the documentation of the Qt Graphical Effects module.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** GNU Free Documentation License
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms
+** and conditions contained in a signed written agreement between you
+** and Nokia.
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+    /*!
+    \page graphicaleffects.html
+    \title Graphical Effects
+    \brief Effects provided by the Qt Graphical Effects API
+
+    Effects are visual items that can be added to Qt Quick user interface as UI
+    components. To import the Qt Graphical Effects types, include the Qt
+    Graphical Effects module by adding the following statement to the QML file:
+
+    \code
+    import QtGraphicalEffects 1.0
+    \endcode
+
+    To use the effects, simply add a specific effect declaration to the QML
+    scene and configure the effects properties. The source item type can be any
+    QML type, even video or another effect. Pipelining multiple effects together
+    is a simple way to create even more impressive output.
+
+    The following list presents the functional division of types that are part
+    of Qt Graphical Effects:
+
+    \section1 Blend
+    \annotatedlist qtgraphicaleffects-blend
+
+    \section1 Color
+    \annotatedlist qtgraphicaleffects-color
+
+    \section1 Gradient
+        \annotatedlist qtgraphicaleffects-gradient
+
+    \section1 Distortion
+        \annotatedlist qtgraphicaleffects-distortion
+
+    \section1 Drop Shadow
+        \annotatedlist qtgraphicaleffects-drop-shadow
+
+    \section1 Blur
+        \annotatedlist qtgraphicaleffects-blur
+
+    \section1 Motion Blur
+        \annotatedlist qtgraphicaleffects-motion-blur
+
+    \section1 Glow
+        \annotatedlist qtgraphicaleffects-glow
+
+    \section1 Mask
+        \annotatedlist qtgraphicaleffects-mask
+    */
diff --git a/doc/src/qtgraphicaleffects-blend.qdoc b/doc/src/qtgraphicaleffects-blend.qdoc
index f2d18ee..c342f08 100644
--- a/doc/src/qtgraphicaleffects-blend.qdoc
+++ b/doc/src/qtgraphicaleffects-blend.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-blend
     \brief Merges two source items by using a blend mode.
 
     Blend mode can be selected with the \l{Blend::mode}{mode} property.
diff --git a/doc/src/qtgraphicaleffects-brightnesscontrast.qdoc b/doc/src/qtgraphicaleffects-brightnesscontrast.qdoc
index 7e82920..b93c664 100644
--- a/doc/src/qtgraphicaleffects-brightnesscontrast.qdoc
+++ b/doc/src/qtgraphicaleffects-brightnesscontrast.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-color
     \brief Adjusts brightness and contrast.
 
     This effect adjusts the source item colors.
diff --git a/doc/src/qtgraphicaleffects-colorize.qdoc b/doc/src/qtgraphicaleffects-colorize.qdoc
index 76c1279..d0e5da2 100644
--- a/doc/src/qtgraphicaleffects-colorize.qdoc
+++ b/doc/src/qtgraphicaleffects-colorize.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-color
     \brief Sets the color in the HSL color space.
 
     The effect is similar to what happens when a colorized glass is put on top
diff --git a/doc/src/qtgraphicaleffects-coloroverlay.qdoc b/doc/src/qtgraphicaleffects-coloroverlay.qdoc
index b563de7..28f1546 100644
--- a/doc/src/qtgraphicaleffects-coloroverlay.qdoc
+++ b/doc/src/qtgraphicaleffects-coloroverlay.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-color
     \brief Alters the colors of the source item by applying an overlay color.
 
     The effect is similar to what happens when a colorized glass is put on top
diff --git a/doc/src/qtgraphicaleffects-conicalgradient.qdoc b/doc/src/qtgraphicaleffects-conicalgradient.qdoc
index 03ee868..4fa9265 100644
--- a/doc/src/qtgraphicaleffects-conicalgradient.qdoc
+++ b/doc/src/qtgraphicaleffects-conicalgradient.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-gradient
     \brief Draws a conical gradient.
 
     A gradient is defined by two or more colors, which are blended seamlessly.
diff --git a/doc/src/qtgraphicaleffects-desaturate.qdoc b/doc/src/qtgraphicaleffects-desaturate.qdoc
index 06488f4..4ffab57 100644
--- a/doc/src/qtgraphicaleffects-desaturate.qdoc
+++ b/doc/src/qtgraphicaleffects-desaturate.qdoc
@@ -30,6 +30,7 @@
     \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
diff --git a/doc/src/qtgraphicaleffects-directionalblur.qdoc b/doc/src/qtgraphicaleffects-directionalblur.qdoc
index 4aa2e11..7529893 100644
--- a/doc/src/qtgraphicaleffects-directionalblur.qdoc
+++ b/doc/src/qtgraphicaleffects-directionalblur.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-motion-blur
     \brief Applies blur effect to the specified direction.
 
     Effect creates perceived impression that the source item appears to be
diff --git a/doc/src/qtgraphicaleffects-displace.qdoc b/doc/src/qtgraphicaleffects-displace.qdoc
index 5517c22..89cbac8 100644
--- a/doc/src/qtgraphicaleffects-displace.qdoc
+++ b/doc/src/qtgraphicaleffects-displace.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-distortion
     \brief Moves the pixels of the source item according to the given
     displacement map.
 
diff --git a/doc/src/qtgraphicaleffects-dropshadow.qdoc b/doc/src/qtgraphicaleffects-dropshadow.qdoc
index 00ee97e..4616063 100644
--- a/doc/src/qtgraphicaleffects-dropshadow.qdoc
+++ b/doc/src/qtgraphicaleffects-dropshadow.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-drop-shadow
     \brief Generates a colorized and blurred shadow image of the
     source and places it behind the original, giving the impression that
     source item is raised from the background.
diff --git a/doc/src/qtgraphicaleffects-fastblur.qdoc b/doc/src/qtgraphicaleffects-fastblur.qdoc
index 8a69612..7a992fc 100644
--- a/doc/src/qtgraphicaleffects-fastblur.qdoc
+++ b/doc/src/qtgraphicaleffects-fastblur.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-blur
     \brief Applies a fast blur effect to one or more source items.
 
     FastBlur offers lower blur quality than
diff --git a/doc/src/qtgraphicaleffects-gammaadjust.qdoc b/doc/src/qtgraphicaleffects-gammaadjust.qdoc
index 1cfb5a4..719256a 100644
--- a/doc/src/qtgraphicaleffects-gammaadjust.qdoc
+++ b/doc/src/qtgraphicaleffects-gammaadjust.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-color
     \brief Alters the luminance of the source item.
 
     GammaAdjust is applied to each pixel according to the curve which is
diff --git a/doc/src/qtgraphicaleffects-gaussianblur.qdoc b/doc/src/qtgraphicaleffects-gaussianblur.qdoc
index 0d1e4e0..d89e69c 100644
--- a/doc/src/qtgraphicaleffects-gaussianblur.qdoc
+++ b/doc/src/qtgraphicaleffects-gaussianblur.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-blur
     \brief Applies a higher quality blur effect.
 
     GaussianBlur effect softens the image by blurring it with an algorithm that
diff --git a/doc/src/qtgraphicaleffects-glow.qdoc b/doc/src/qtgraphicaleffects-glow.qdoc
index 153ec73..c016b20 100644
--- a/doc/src/qtgraphicaleffects-glow.qdoc
+++ b/doc/src/qtgraphicaleffects-glow.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-glow
     \brief Generates a blurred and colorized image of the source and places it
     behind the original, giving impression that the source is glowing.
 
diff --git a/doc/src/qtgraphicaleffects-huesaturation.qdoc b/doc/src/qtgraphicaleffects-huesaturation.qdoc
index 066e06b..3b46bc8 100644
--- a/doc/src/qtgraphicaleffects-huesaturation.qdoc
+++ b/doc/src/qtgraphicaleffects-huesaturation.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-color
     \brief Alters the source item colors in the HSL color space.
 
     HueSaturation is similar to the \l{QtGraphicalEffects1::Colorize}{Colorize} effect, but the hue and
diff --git a/doc/src/qtgraphicaleffects-innershadow.qdoc b/doc/src/qtgraphicaleffects-innershadow.qdoc
index 642edc4..26de401 100644
--- a/doc/src/qtgraphicaleffects-innershadow.qdoc
+++ b/doc/src/qtgraphicaleffects-innershadow.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-drop-shadow
     \brief Generates a colorized and blurred shadow inside the
     source.
 
diff --git a/doc/src/qtgraphicaleffects-leveladjust.qdoc b/doc/src/qtgraphicaleffects-leveladjust.qdoc
index 98f6b67..0129286 100644
--- a/doc/src/qtgraphicaleffects-leveladjust.qdoc
+++ b/doc/src/qtgraphicaleffects-leveladjust.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-color
     \brief Adjusts color levels in the RGBA color space.
 
     This effect adjusts the source item colors separately for each color channel.
diff --git a/doc/src/qtgraphicaleffects-lineargradient.qdoc b/doc/src/qtgraphicaleffects-lineargradient.qdoc
index f293be0..a4a4f01 100644
--- a/doc/src/qtgraphicaleffects-lineargradient.qdoc
+++ b/doc/src/qtgraphicaleffects-lineargradient.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-gradient
     \brief Draws a linear gradient.
 
     A gradient is defined by two or more colors, which are blended seamlessly.
diff --git a/doc/src/qtgraphicaleffects-maskedblur.qdoc b/doc/src/qtgraphicaleffects-maskedblur.qdoc
index 5121acf..7c535e2 100644
--- a/doc/src/qtgraphicaleffects-maskedblur.qdoc
+++ b/doc/src/qtgraphicaleffects-maskedblur.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-blur
     \brief Applies a blur effect with a varying intesity.
 
     MaskedBlur effect softens the image by blurring it. The intensity of the blur
diff --git a/doc/src/qtgraphicaleffects-opacitymask.qdoc b/doc/src/qtgraphicaleffects-opacitymask.qdoc
index 6cb1e67..085c443 100644
--- a/doc/src/qtgraphicaleffects-opacitymask.qdoc
+++ b/doc/src/qtgraphicaleffects-opacitymask.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-mask
     \brief Masks the source item with another item.
 
     \table
diff --git a/doc/src/qtgraphicaleffects-radialblur.qdoc b/doc/src/qtgraphicaleffects-radialblur.qdoc
index 0656a08..8b04331 100644
--- a/doc/src/qtgraphicaleffects-radialblur.qdoc
+++ b/doc/src/qtgraphicaleffects-radialblur.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-motion-blur
     \brief Applies directional blur in a circular direction around the items center
     point.
 
diff --git a/doc/src/qtgraphicaleffects-radialgradient.qdoc b/doc/src/qtgraphicaleffects-radialgradient.qdoc
index e26ef8e..943c9f8 100644
--- a/doc/src/qtgraphicaleffects-radialgradient.qdoc
+++ b/doc/src/qtgraphicaleffects-radialgradient.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-gradient
     \brief Draws a radial gradient.
 
     A gradient is defined by two or more colors, which are blended seamlessly.
diff --git a/doc/src/qtgraphicaleffects-rectangularglow.qdoc b/doc/src/qtgraphicaleffects-rectangularglow.qdoc
index b6c643d..adfca64 100644
--- a/doc/src/qtgraphicaleffects-rectangularglow.qdoc
+++ b/doc/src/qtgraphicaleffects-rectangularglow.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-glow
     \brief Generates a blurred and colorized rectangle, which gives
     the impression that the source is glowing.
 
diff --git a/doc/src/qtgraphicaleffects-recursiveblur.qdoc b/doc/src/qtgraphicaleffects-recursiveblur.qdoc
index e27f3e5..8d94b16 100644
--- a/doc/src/qtgraphicaleffects-recursiveblur.qdoc
+++ b/doc/src/qtgraphicaleffects-recursiveblur.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-blur
     \brief Blurs repeatedly, providing a strong blur effect.
 
     The RecursiveBlur effect softens the image by blurring it with an algorithm
diff --git a/doc/src/qtgraphicaleffects-thresholdmask.qdoc b/doc/src/qtgraphicaleffects-thresholdmask.qdoc
index c9bc278..5faa4ef 100644
--- a/doc/src/qtgraphicaleffects-thresholdmask.qdoc
+++ b/doc/src/qtgraphicaleffects-thresholdmask.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-mask
     \brief Masks the source item with another item and applies a threshold value.
 
     The masking behavior can be controlled with the \l threshold value for the
diff --git a/doc/src/qtgraphicaleffects-zoomblur.qdoc b/doc/src/qtgraphicaleffects-zoomblur.qdoc
index 2f3dd8a..e651729 100644
--- a/doc/src/qtgraphicaleffects-zoomblur.qdoc
+++ b/doc/src/qtgraphicaleffects-zoomblur.qdoc
@@ -30,6 +30,7 @@
     \inqmlmodule QtGraphicalEffects 1.0
     \since QtGraphicalEffects 1.0
     \inherits QtQuick2::Item
+    \ingroup qtgraphicaleffects-motion-blur
     \brief Applies directional blur effect towards source items center point.
 
     Effect creates perceived impression that the source item appears to be