From 7b9a93da86d28b325d164dd5aed78c1400b044ce Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Mon, 11 Jun 2012 10:44:20 +0200 Subject: Doc: Fixing links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit -added the QML module identifier in the links. Change-Id: I2ddc927d14cb2a25f63aaafdb22c233779db0b19 Reviewed-by: Michalina Ziemba Reviewed-by: Marko Niemelä --- doc/src/qtgraphicaleffects-blend.qdoc | 6 +++--- doc/src/qtgraphicaleffects-colorize.qdoc | 4 ++-- doc/src/qtgraphicaleffects-directionalblur.qdoc | 6 +++--- doc/src/qtgraphicaleffects-displace.qdoc | 4 ++-- doc/src/qtgraphicaleffects-dropshadow.qdoc | 6 +++--- doc/src/qtgraphicaleffects-fastblur.qdoc | 4 ++-- doc/src/qtgraphicaleffects-gammaadjust.qdoc | 2 +- doc/src/qtgraphicaleffects-gaussianblur.qdoc | 4 ++-- doc/src/qtgraphicaleffects-glow.qdoc | 4 ++-- doc/src/qtgraphicaleffects-huesaturation.qdoc | 2 +- doc/src/qtgraphicaleffects-innershadow.qdoc | 6 +++--- doc/src/qtgraphicaleffects-lineargradient.qdoc | 4 ++-- doc/src/qtgraphicaleffects-maskedblur.qdoc | 10 +++++----- doc/src/qtgraphicaleffects-radialblur.qdoc | 6 +++--- doc/src/qtgraphicaleffects-radialgradient.qdoc | 6 +++--- doc/src/qtgraphicaleffects-recursiveblur.qdoc | 4 ++-- doc/src/qtgraphicaleffects-thresholdmask.qdoc | 10 +++++----- doc/src/qtgraphicaleffects-zoomblur.qdoc | 6 +++--- 18 files changed, 47 insertions(+), 47 deletions(-) diff --git a/doc/src/qtgraphicaleffects-blend.qdoc b/doc/src/qtgraphicaleffects-blend.qdoc index 425bd48..f2d18ee 100644 --- a/doc/src/qtgraphicaleffects-blend.qdoc +++ b/doc/src/qtgraphicaleffects-blend.qdoc @@ -32,7 +32,7 @@ \inherits QtQuick2::Item \brief Merges two source items by using a blend mode. - Blend mode can be selected with the \l mode property. + Blend mode can be selected with the \l{Blend::mode}{mode} property. \table \header @@ -55,14 +55,14 @@ /*! \qmlproperty variant QtGraphicalEffects1.0::Blend::source - This property defines the source item that is going to be the base when \l foregroundSource is blended over it. + This property defines the source item that is going to be the base when \l{Blend::foregroundSource}{foregroundSource} is blended over it. */ /*! \qmlproperty variant QtGraphicalEffects1.0::Blend::foregroundSource - This property defines the item that is going to be blended over the \l source. + This property defines the item that is going to be blended over the \l{Blend::source}{source}. */ diff --git a/doc/src/qtgraphicaleffects-colorize.qdoc b/doc/src/qtgraphicaleffects-colorize.qdoc index 705d0fa..76c1279 100644 --- a/doc/src/qtgraphicaleffects-colorize.qdoc +++ b/doc/src/qtgraphicaleffects-colorize.qdoc @@ -36,10 +36,10 @@ of a grayscale image. Colorize uses the hue, saturation, and lightness (HSL) color space. You can specify a desired value for each property. You can shift all HSL values with the - \l {QtGraphicalEffects1.0::HueSaturation}{HueSaturation} effect. + \l{QtGraphicalEffects1::HueSaturation}{HueSaturation} effect. Alternatively, you can use the - \l {QtGraphicalEffects1.0::ColorOverlay}{ColorOverlay} effect to colorize the + \l{QtGraphicalEffects1::ColorOverlay}{ColorOverlay} effect to colorize the source item in the RGBA color space. \table diff --git a/doc/src/qtgraphicaleffects-directionalblur.qdoc b/doc/src/qtgraphicaleffects-directionalblur.qdoc index 7b1133e..4aa2e11 100644 --- a/doc/src/qtgraphicaleffects-directionalblur.qdoc +++ b/doc/src/qtgraphicaleffects-directionalblur.qdoc @@ -37,8 +37,8 @@ each pixel, therefore setting the direction to 0 and 180 provides the same result. - Other available motionblur effects are \l {QtGraphicalEffects1.0::ZoomBlur} {ZoomBlur} and - \l {QtGraphicalEffects1.0::RadialBlur} {RadialBlur}. + Other available motionblur effects are \l{QtGraphicalEffects1::ZoomBlur}{ZoomBlur} and + \l{QtGraphicalEffects1::RadialBlur}{RadialBlur}. \table \header @@ -69,7 +69,7 @@ This property defines the percieved amount of movement for each pixel. The movement is divided evenly to both sides of each pixel. - The quality of the blur depends on \l samples property. If length value is + The quality of the blur depends on \l{DirectionalBlur::samples}{samples} property. If length value is large, more samples are needed to keep the visual quality at high level. The value ranges from 0.0 to inf. diff --git a/doc/src/qtgraphicaleffects-displace.qdoc b/doc/src/qtgraphicaleffects-displace.qdoc index 1f1912d..5517c22 100644 --- a/doc/src/qtgraphicaleffects-displace.qdoc +++ b/doc/src/qtgraphicaleffects-displace.qdoc @@ -55,7 +55,7 @@ \qmlproperty variant QtGraphicalEffects1.0::Displace::source This property defines the source item for the pixels that are going to be - displaced according to the data from \l displacementSource. + displaced according to the data from \l{Displace::displacementSource}{displacementSource}. */ @@ -73,7 +73,7 @@ Alternatively, the displacement map for this effect can also be a QML element which is colored appropriately. Like any QML element, it can be animated. It is recommended that the size of the diplacement map matches the - size of the \l source. + size of the \l{Displace::source}{source}. The displace data is interpreted in the RGBA format. For every pixel: the red channel stores the x-axis displacement, and the green channel stores the diff --git a/doc/src/qtgraphicaleffects-dropshadow.qdoc b/doc/src/qtgraphicaleffects-dropshadow.qdoc index eea3b40..00ee97e 100644 --- a/doc/src/qtgraphicaleffects-dropshadow.qdoc +++ b/doc/src/qtgraphicaleffects-dropshadow.qdoc @@ -39,7 +39,7 @@ rendering speed is reduced especially if the shadow edges are heavily softened. For use cases that require faster rendering speed and for which the highest - possible visual quality is not necessary, property \l fast can be set to true. + possible visual quality is not necessary, property \l{DropShadow::fast}{fast} can be set to true. \table \header @@ -71,7 +71,7 @@ Radius defines the softness of the shadow. A larger radius causes the edges of the shadow to appear more blurry. - Depending on the radius value, value of the \l samples should be set to sufficiently + Depending on the radius value, value of the \l{DropShadow::samples}{samples} should be set to sufficiently large to ensure the visual quality. The value ranges from 0.0 (no blur) to inf. By default, the property is set to @@ -130,7 +130,7 @@ This property is not intended to be animated. Changing this property may cause the underlying OpenGL shaders to be recompiled. - When \l fast property is set to true, this property has no effect. + When \l{DropShadow::fast}{fast} property is set to true, this property has no effect. */ diff --git a/doc/src/qtgraphicaleffects-fastblur.qdoc b/doc/src/qtgraphicaleffects-fastblur.qdoc index 72745c1..8a69612 100644 --- a/doc/src/qtgraphicaleffects-fastblur.qdoc +++ b/doc/src/qtgraphicaleffects-fastblur.qdoc @@ -32,8 +32,8 @@ \inherits QtQuick2::Item \brief Applies a fast blur effect to one or more source items. - FastBlur offers lower blur quality than \l - {QtGraphicalEffects1.0::GaussianBlur} {GaussianBlur}, but it is faster to + FastBlur offers lower blur quality than + \l{QtGraphicalEffects1::GaussianBlur}{GaussianBlur}, but it is faster to render. The FastBlur effect softens the source content by blurring it with algorithm which uses the source content downscaling and bilinear filtering. Use this effect in situations where the source content is rapidly changing diff --git a/doc/src/qtgraphicaleffects-gammaadjust.qdoc b/doc/src/qtgraphicaleffects-gammaadjust.qdoc index 76d89fa..1cfb5a4 100644 --- a/doc/src/qtgraphicaleffects-gammaadjust.qdoc +++ b/doc/src/qtgraphicaleffects-gammaadjust.qdoc @@ -34,7 +34,7 @@ GammaAdjust is applied to each pixel according to the curve which is pre-defined as a power-law expression, where the property gamma is used as the - reciprocal scaling exponent. Refer to the property documentation of \l gamma + reciprocal scaling exponent. Refer to the property documentation of \l{GammaAdjust::gamma}{gamma} for more details. \table diff --git a/doc/src/qtgraphicaleffects-gaussianblur.qdoc b/doc/src/qtgraphicaleffects-gaussianblur.qdoc index a51ccb4..0d1e4e0 100644 --- a/doc/src/qtgraphicaleffects-gaussianblur.qdoc +++ b/doc/src/qtgraphicaleffects-gaussianblur.qdoc @@ -34,7 +34,7 @@ GaussianBlur effect softens the image by blurring it with an algorithm that uses the Gaussian function to calculate the effect. The effect produces - higher quality than \l FastBlur, but is slower to render. + higher quality than \l{QtGraphicalEffects1::FastBlur}{FastBlur}, but is slower to render. \table \header @@ -65,7 +65,7 @@ the blurring of an individual pixel. A larger radius increases the blur effect. - Depending on the radius value, value of the \l samples should be set to + Depending on the radius value, value of the \l{GaussianBlur::samples}{samples} should be set to sufficiently large to ensure the visual quality. The value ranges from 0.0 (no blur) to inf. By default, the property is set to diff --git a/doc/src/qtgraphicaleffects-glow.qdoc b/doc/src/qtgraphicaleffects-glow.qdoc index 3dc89fb..153ec73 100644 --- a/doc/src/qtgraphicaleffects-glow.qdoc +++ b/doc/src/qtgraphicaleffects-glow.qdoc @@ -37,7 +37,7 @@ speed of the effect may not be the highest possible. The rendering speed is reduced especially if the glow edges are heavily softened. For use cases that require faster rendering speed and the highest possible - visual quality is not necessary, property \l fast can be set to true. + visual quality is not necessary, property \l{Glow::fast}{fast} can be set to true. \table \header @@ -69,7 +69,7 @@ Radius defines the softness of the glow. A larger radius causes the edges of the glow to appear more blurry. - Depending on the radius value, value of the \l samples should be set to sufficiently + Depending on the radius value, value of the \l{Glow::samples}{samples} should be set to sufficiently large to ensure the visual quality. The value ranges from 0.0 (no blur) to inf. By default, the property is set to diff --git a/doc/src/qtgraphicaleffects-huesaturation.qdoc b/doc/src/qtgraphicaleffects-huesaturation.qdoc index ba4a66a..066e06b 100644 --- a/doc/src/qtgraphicaleffects-huesaturation.qdoc +++ b/doc/src/qtgraphicaleffects-huesaturation.qdoc @@ -32,7 +32,7 @@ \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 + HueSaturation is similar to the \l{QtGraphicalEffects1::Colorize}{Colorize} effect, but the hue and saturation property values are handled differently. The HueSaturation effect always shifts the hue, saturation, and lightness from the original, instead of setting them. diff --git a/doc/src/qtgraphicaleffects-innershadow.qdoc b/doc/src/qtgraphicaleffects-innershadow.qdoc index 425d452..642edc4 100644 --- a/doc/src/qtgraphicaleffects-innershadow.qdoc +++ b/doc/src/qtgraphicaleffects-innershadow.qdoc @@ -37,7 +37,7 @@ rendering speed of the shadow might not be the highest possible. The rendering speed is reduced especially if the shadow edges are heavily softened. For use cases that require faster rendering speed and for which the - highest possible visual quality is not necessary, property \l fast can be + highest possible visual quality is not necessary, property \l{InnerShadow::fast}{fast} can be set to true. \table @@ -70,7 +70,7 @@ Radius defines the softness of the shadow. A larger radius causes the edges of the shadow to appear more blurry. - Depending on the radius value, value of the \l samples should be set to sufficiently + Depending on the radius value, value of the \l{InnerShadow::samples}{samples} should be set to sufficiently large to ensure the visual quality. The value ranges from 0.0 (no blur) to inf. By default, the property is set to @@ -129,7 +129,7 @@ This property is not intended to be animated. Changing this property may cause the underlying OpenGL shaders to be recompiled. - When \l fast property is set to true, this property has no effect. + When \l{InnerShadow::fast}{fast} property is set to true, this property has no effect. */ diff --git a/doc/src/qtgraphicaleffects-lineargradient.qdoc b/doc/src/qtgraphicaleffects-lineargradient.qdoc index e0b2191..f293be0 100644 --- a/doc/src/qtgraphicaleffects-lineargradient.qdoc +++ b/doc/src/qtgraphicaleffects-lineargradient.qdoc @@ -159,7 +159,7 @@ Gradient { position of 0.0 is rendered. Colors at larger position values are rendered linearly towards the end point. The point is given in pixels and the default value is Qt.point(0, 0). - Setting the default values for the start and \l end results in a full height + Setting the default values for the start and \l{LinearGradient::end}{end} results in a full height linear gradient on the y-axis. \table @@ -190,7 +190,7 @@ Gradient { of 1.0 is rendered. Colors at smaller position values are rendered linearly towards the start point. The point is given in pixels and the default value is Qt.point(0, height). - Setting the default values for the \l start and end results in a full height + Setting the default values for the \l{LinearGradient::start}{start} and end results in a full height linear gradient on the y-axis. \table diff --git a/doc/src/qtgraphicaleffects-maskedblur.qdoc b/doc/src/qtgraphicaleffects-maskedblur.qdoc index 2b9bafb..5121acf 100644 --- a/doc/src/qtgraphicaleffects-maskedblur.qdoc +++ b/doc/src/qtgraphicaleffects-maskedblur.qdoc @@ -36,9 +36,9 @@ can be controlled for each pixel using maskSource so that some parts of the source are blurred more than others. By default the effect produces a high quality result, thus the rendering speed may not be the highest possible. - The rendering speed is reduced especially if the \l samples is large. + The rendering speed is reduced especially if the \l{MaskedBlur::samples}{samples} is large. For use cases that require faster rendering speed and the highest possible visual - quality is not necessary, property \l fast can be set to true. + quality is not necessary, property \l{MaskedBlur::fast}{fast} can be set to true. \table \header @@ -71,7 +71,7 @@ This property defines the item that is controlling the final intensity of the blur. The pixel alpha channel value from maskSource defines the actual blur radius that is going to be used for blurring the corresponding source pixel. - Opaque maskSource pixels produce blur with specified \l radius, while transparent + Opaque maskSource pixels produce blur with specified \l{MaskedBlur::radius}{radius}, while transparent pixels suppress the blur completely. Semitransparent maskSource pixels produce blur with a radius that is interpolated according to the pixel transparency level. @@ -85,7 +85,7 @@ the blurring of an individual pixel. A larger radius increases the blur effect. - Depending on the radius value, value of the \l samples should be set to + Depending on the radius value, value of the \l{MaskedBlur::samples}{samples} should be set to sufficiently large to ensure the visual quality. The value ranges from 0.0 (no blur) to inf. By default, the property is set to @@ -136,7 +136,7 @@ This property is not intended to be animated. Changing this property may cause the underlying OpenGL shaders to be recompiled. - When \l fast property is set to true, this property has no effect. + When \l{MaskedBlur::fast}{fast} property is set to true, this property has no effect. */ /*! diff --git a/doc/src/qtgraphicaleffects-radialblur.qdoc b/doc/src/qtgraphicaleffects-radialblur.qdoc index af25a48..0656a08 100644 --- a/doc/src/qtgraphicaleffects-radialblur.qdoc +++ b/doc/src/qtgraphicaleffects-radialblur.qdoc @@ -37,8 +37,8 @@ to the direction of the blur. Other available motionblur effects are - \l {QtGraphicalEffects1.0::ZoomBlur} {ZoomBlur} and - \l {QtGraphicalEffects1.0::DirectionalBlur} {DirectionalBlur}. + \l{QtGraphicalEffects1::ZoomBlur}{ZoomBlur} and + \l{QtGraphicalEffects1::DirectionalBlur}{DirectionalBlur}. \table \header @@ -84,7 +84,7 @@ This property defines the direction for the blur and at the same time the level of blurring. The larger the angle, the more the result - becomes blurred. The quality of the blur depends on \l samples property. + becomes blurred. The quality of the blur depends on \l{RadialBlur::samples}{samples} property. If angle value is large, more samples are needed to keep the visual quality at high level. diff --git a/doc/src/qtgraphicaleffects-radialgradient.qdoc b/doc/src/qtgraphicaleffects-radialgradient.qdoc index 815b75c..e26ef8e 100644 --- a/doc/src/qtgraphicaleffects-radialgradient.qdoc +++ b/doc/src/qtgraphicaleffects-radialgradient.qdoc @@ -93,9 +93,9 @@ \qmlproperty real QtGraphicalEffects1.0::RadialGradient::angle This property defines the rotation of the gradient around its center point. - The rotation is only visible when the \l horizontalRadius and \l - verticalRadius properties are not equal. The angle is given in degrees and - the default value is \c 0. + The rotation is only visible when the \l{RadialGradient::horizontalRadius}{horizontalRadius} + and \l{RadialGradient::verticalRadius}{verticalRadius} properties are not equal. The angle + is given in degrees and the default value is \c 0. \table \header diff --git a/doc/src/qtgraphicaleffects-recursiveblur.qdoc b/doc/src/qtgraphicaleffects-recursiveblur.qdoc index b421fc4..e27f3e5 100644 --- a/doc/src/qtgraphicaleffects-recursiveblur.qdoc +++ b/doc/src/qtgraphicaleffects-recursiveblur.qdoc @@ -34,8 +34,8 @@ The RecursiveBlur effect softens the image by blurring it with an algorithm that uses a recursive feedback loop to blur the source multiple times. The - effect may give more blurry results than \l {QtGraphicalEffects1.0::GaussianBlur} {GaussianBlur} or \l FastBlur, - but the result is produced asynchronously and takes more time. + effect may give more blurry results than \l{QtGraphicalEffects1::GaussianBlur}{GaussianBlur} or + \l{QtGraphicalEffects1::FastBlur}{FastBlur}, but the result is produced asynchronously and takes more time. \table \header diff --git a/doc/src/qtgraphicaleffects-thresholdmask.qdoc b/doc/src/qtgraphicaleffects-thresholdmask.qdoc index 3913f97..c9bc278 100644 --- a/doc/src/qtgraphicaleffects-thresholdmask.qdoc +++ b/doc/src/qtgraphicaleffects-thresholdmask.qdoc @@ -112,11 +112,11 @@ /*! \qmlproperty real QtGraphicalEffects1.0::ThresholdMask::spread - This property defines the smoothness of the mask edges near the \l threshold - alpha value. Setting spread to 0.0 uses mask normally with the specified - threshold. Setting higher spread values softens the transition from the - transparent mask pixels towards opaque mask pixels by adding interpolated - values between them. + This property defines the smoothness of the mask edges near the + \l{ThresholdMask::threshold}{threshold} alpha value. Setting spread to 0.0 + uses mask normally with the specified threshold. Setting higher spread values + softens the transition from the transparent mask pixels towards opaque mask + pixels by adding interpolated values between them. The value ranges from 0.0 (sharp mask edge) to 1.0 (smooth mask edge). By default, the property is set to \c 0.0. diff --git a/doc/src/qtgraphicaleffects-zoomblur.qdoc b/doc/src/qtgraphicaleffects-zoomblur.qdoc index a20a6d1..2f3dd8a 100644 --- a/doc/src/qtgraphicaleffects-zoomblur.qdoc +++ b/doc/src/qtgraphicaleffects-zoomblur.qdoc @@ -35,8 +35,8 @@ Effect creates perceived impression that the source item appears to be moving towards the center point in Z-direction or that the camera appears to be zooming rapidly. Other available motion blur effects are - \l {QtGraphicalEffects1.0::DirectionalBlur} {DirectionalBlur} - and \l {QtGraphicalEffects1.0::RadialBlur} {RadialBlur}. + \l{QtGraphicalEffects1::DirectionalBlur}{DirectionalBlur} + and \l{QtGraphicalEffects1::RadialBlur}{RadialBlur}. \table \header @@ -68,7 +68,7 @@ pixel. The amount is smaller near the center and reaches the specified value at the edges. - The quality of the blur depends on \l samples property. If length value is + The quality of the blur depends on \l{ZoomBlur::samples}{samples} property. If length value is large, more samples are needed to keep the visual quality at high level. The value ranges from 0.0 to inf. -- cgit v1.2.1