Added \since and \inherits tags to all qdocs

All effects are now documented to inherit QML Item element
because Item is the root element for the effects. This is
the recommended way to document QML components.

Change-Id: I2b724de1be6deec9bbc1698bd3ff0e798252b755
Reviewed-by: Kim Gronholm <kim.1.gronholm@nokia.com>

25 files changed, 50 insertions, 0 deletions

diff --git a/doc/src/qtgraphicaleffects-blend.qdoc b/doc/src/qtgraphicaleffects-blend.qdoc
index 133397b..425bd48 100644
--- a/doc/src/qtgraphicaleffects-blend.qdoc
+++ b/doc/src/qtgraphicaleffects-blend.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass Blend
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \brief Merges two source items by using a blend mode.
 
     Blend mode can be selected with the \l mode property.
diff --git a/doc/src/qtgraphicaleffects-brightnesscontrast.qdoc b/doc/src/qtgraphicaleffects-brightnesscontrast.qdoc
index 4fdc437..7e82920 100644
--- a/doc/src/qtgraphicaleffects-brightnesscontrast.qdoc
+++ b/doc/src/qtgraphicaleffects-brightnesscontrast.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass BrightnessContrast
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 1b2f582..705d0fa 100644
--- a/doc/src/qtgraphicaleffects-colorize.qdoc
+++ b/doc/src/qtgraphicaleffects-colorize.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass Colorize
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 c35910a..6ee3b29 100644
--- a/doc/src/qtgraphicaleffects-coloroverlay.qdoc
+++ b/doc/src/qtgraphicaleffects-coloroverlay.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass ColorOverlay
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 7b35d18..03ee868 100644
--- a/doc/src/qtgraphicaleffects-conicalgradient.qdoc
+++ b/doc/src/qtgraphicaleffects-conicalgradient.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass ConicalGradient
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 43d3225..06488f4 100644
--- a/doc/src/qtgraphicaleffects-desaturate.qdoc
+++ b/doc/src/qtgraphicaleffects-desaturate.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass Desaturate
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 56f8485..4543f8b 100644
--- a/doc/src/qtgraphicaleffects-directionalblur.qdoc
+++ b/doc/src/qtgraphicaleffects-directionalblur.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass DirectionalBlur
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 1bb0ded..1f1912d 100644
--- a/doc/src/qtgraphicaleffects-displace.qdoc
+++ b/doc/src/qtgraphicaleffects-displace.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass Displace
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 43986a9..5d5f23d 100644
--- a/doc/src/qtgraphicaleffects-dropshadow.qdoc
+++ b/doc/src/qtgraphicaleffects-dropshadow.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass DropShadow
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 e2095da..72745c1 100644
--- a/doc/src/qtgraphicaleffects-fastblur.qdoc
+++ b/doc/src/qtgraphicaleffects-fastblur.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass FastBlur
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \brief Applies a fast blur effect to one or more source items.
 
     FastBlur offers lower blur quality than \l
diff --git a/doc/src/qtgraphicaleffects-gammaadjust.qdoc b/doc/src/qtgraphicaleffects-gammaadjust.qdoc
index a137d28..76d89fa 100644
--- a/doc/src/qtgraphicaleffects-gammaadjust.qdoc
+++ b/doc/src/qtgraphicaleffects-gammaadjust.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass GammaAdjust
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 b01c977..a51ccb4 100644
--- a/doc/src/qtgraphicaleffects-gaussianblur.qdoc
+++ b/doc/src/qtgraphicaleffects-gaussianblur.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass GaussianBlur
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 a888b04..c9546b4 100644
--- a/doc/src/qtgraphicaleffects-glow.qdoc
+++ b/doc/src/qtgraphicaleffects-glow.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass Glow
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 a239791..ba4a66a 100644
--- a/doc/src/qtgraphicaleffects-huesaturation.qdoc
+++ b/doc/src/qtgraphicaleffects-huesaturation.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass HueSaturation
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \brief Alters the source item colors in the HSL color space.
 
     HueSaturation is similar to the \l Colorize effect, but the hue and
diff --git a/doc/src/qtgraphicaleffects-innershadow.qdoc b/doc/src/qtgraphicaleffects-innershadow.qdoc
index 4a2ad85..cac2c74 100644
--- a/doc/src/qtgraphicaleffects-innershadow.qdoc
+++ b/doc/src/qtgraphicaleffects-innershadow.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass InnerShadow
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 e535afe..98f6b67 100644
--- a/doc/src/qtgraphicaleffects-leveladjust.qdoc
+++ b/doc/src/qtgraphicaleffects-leveladjust.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass LevelAdjust
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 fc46e78..e0b2191 100644
--- a/doc/src/qtgraphicaleffects-lineargradient.qdoc
+++ b/doc/src/qtgraphicaleffects-lineargradient.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass LinearGradient
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 330c67a..7bb8b9b 100644
--- a/doc/src/qtgraphicaleffects-maskedblur.qdoc
+++ b/doc/src/qtgraphicaleffects-maskedblur.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass MaskedBlur
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 e0e06a7..6cb1e67 100644
--- a/doc/src/qtgraphicaleffects-opacitymask.qdoc
+++ b/doc/src/qtgraphicaleffects-opacitymask.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass OpacityMask
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \brief Masks the source item with another item.
 
     \table
diff --git a/doc/src/qtgraphicaleffects-radialblur.qdoc b/doc/src/qtgraphicaleffects-radialblur.qdoc
index 749b093..53a94a7 100644
--- a/doc/src/qtgraphicaleffects-radialblur.qdoc
+++ b/doc/src/qtgraphicaleffects-radialblur.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass RadialBlur
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 8d66498..815b75c 100644
--- a/doc/src/qtgraphicaleffects-radialgradient.qdoc
+++ b/doc/src/qtgraphicaleffects-radialgradient.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass RadialGradient
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 5d785cc..244c441 100644
--- a/doc/src/qtgraphicaleffects-rectangularglow.qdoc
+++ b/doc/src/qtgraphicaleffects-rectangularglow.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass RectangularGlow
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 a99069e..b421fc4 100644
--- a/doc/src/qtgraphicaleffects-recursiveblur.qdoc
+++ b/doc/src/qtgraphicaleffects-recursiveblur.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass RecursiveBlur
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 19a3812..3913f97 100644
--- a/doc/src/qtgraphicaleffects-thresholdmask.qdoc
+++ b/doc/src/qtgraphicaleffects-thresholdmask.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass ThresholdMask
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \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 ed64ba6..f310b0b 100644
--- a/doc/src/qtgraphicaleffects-zoomblur.qdoc
+++ b/doc/src/qtgraphicaleffects-zoomblur.qdoc
@@ -28,6 +28,8 @@
 /*!
     \qmlclass ZoomBlur
     \inqmlmodule QtGraphicalEffects 1.0
+    \since QtGraphicalEffects 1.0
+    \inherits QtQuick2::Item
     \brief Applies directional blur effect towards source items center point.
 
     Effect creates perceived impression that the source item appears to be