aboutsummaryrefslogtreecommitdiffstats
path: root/src/quick/items/qquickshadereffectsource.cpp
diff options
context:
space:
mode:
authorBea Lam <bea.lam@nokia.com>2012-08-06 14:25:24 +1000
committerQt by Nokia <qt-info@nokia.com>2012-08-08 04:11:17 +0200
commitb2120f68683b7948891d72fe077f44ab7e6baf18 (patch)
treeede9def668f55f2f32448700da5e6fdf80b3cad6 /src/quick/items/qquickshadereffectsource.cpp
parentec519529087cc3005d55242569dcbca3dcee91bf (diff)
Fix uses of various qml doc commands
Signals documented with \qmlsignal should indicate handler name, i.e. 'onSignal' rather than 'signal'. Methods documented with \qmlmethod do not need to document 'void' return values. Also the name of any documented attribute should be qualified with 'QtQuick2::<qmltype>'. Change-Id: I206dd9e8f39c3b84e029ae9d4101b05d0bfb3478 Reviewed-by: Andrew den Exter <andrew.den-exter@nokia.com>
Diffstat (limited to 'src/quick/items/qquickshadereffectsource.cpp')
-rw-r--r--src/quick/items/qquickshadereffectsource.cpp20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/quick/items/qquickshadereffectsource.cpp b/src/quick/items/qquickshadereffectsource.cpp
index 2bb2aa6604..219258b41b 100644
--- a/src/quick/items/qquickshadereffectsource.cpp
+++ b/src/quick/items/qquickshadereffectsource.cpp
@@ -608,7 +608,7 @@ QSGTextureProvider *QQuickShaderEffectSource::textureProvider() const
}
/*!
- \qmlproperty enumeration ShaderEffectSource::wrapMode
+ \qmlproperty enumeration QtQuick2::ShaderEffectSource::wrapMode
This property defines the OpenGL wrap modes associated with the texture.
Modifying this property makes most sense when the item is used as a
@@ -640,7 +640,7 @@ void QQuickShaderEffectSource::setWrapMode(WrapMode mode)
}
/*!
- \qmlproperty Item ShaderEffectSource::sourceItem
+ \qmlproperty Item QtQuick2::ShaderEffectSource::sourceItem
This property holds the item to be rendered into the texture.
Setting this to null while \l live is true, will release the texture
@@ -700,7 +700,7 @@ void QQuickShaderEffectSource::sourceItemDestroyed(QObject *item)
/*!
- \qmlproperty rect ShaderEffectSource::sourceRect
+ \qmlproperty rect QtQuick2::ShaderEffectSource::sourceRect
This property defines which rectangular area of the \l sourceItem to
render into the texture. The source rectangle can be larger than
@@ -723,7 +723,7 @@ void QQuickShaderEffectSource::setSourceRect(const QRectF &rect)
}
/*!
- \qmlproperty size ShaderEffectSource::textureSize
+ \qmlproperty size QtQuick2::ShaderEffectSource::textureSize
This property holds the requested size of the texture. If it is empty,
which is the default, the size of the source rectangle is used.
@@ -748,7 +748,7 @@ void QQuickShaderEffectSource::setTextureSize(const QSize &size)
}
/*!
- \qmlproperty enumeration ShaderEffectSource::format
+ \qmlproperty enumeration QtQuick2::ShaderEffectSource::format
This property defines the internal OpenGL format of the texture.
Modifying this property makes most sense when the item is used as a
@@ -779,7 +779,7 @@ void QQuickShaderEffectSource::setFormat(QQuickShaderEffectSource::Format format
}
/*!
- \qmlproperty bool ShaderEffectSource::live
+ \qmlproperty bool QtQuick2::ShaderEffectSource::live
If this property is true, the texture is updated whenever the
\l sourceItem updates. Otherwise, it will be a frozen image, even if
@@ -801,7 +801,7 @@ void QQuickShaderEffectSource::setLive(bool live)
}
/*!
- \qmlproperty bool ShaderEffectSource::hideSource
+ \qmlproperty bool QtQuick2::ShaderEffectSource::hideSource
If this property is true, the \l sourceItem is hidden, though it will still
be rendered into the texture. As opposed to hiding the \l sourceItem by
@@ -830,7 +830,7 @@ void QQuickShaderEffectSource::setHideSource(bool hide)
}
/*!
- \qmlproperty bool ShaderEffectSource::mipmap
+ \qmlproperty bool QtQuick2::ShaderEffectSource::mipmap
If this property is true, mipmaps are generated for the texture.
@@ -853,7 +853,7 @@ void QQuickShaderEffectSource::setMipmap(bool enabled)
}
/*!
- \qmlproperty bool ShaderEffectSource::recursive
+ \qmlproperty bool QtQuick2::ShaderEffectSource::recursive
Set this property to true if the ShaderEffectSource has a dependency on
itself. ShaderEffectSources form a dependency chain, where one
@@ -884,7 +884,7 @@ void QQuickShaderEffectSource::setRecursive(bool enabled)
}
/*!
- \qmlmethod ShaderEffectSource::scheduleUpdate()
+ \qmlmethod QtQuick2::ShaderEffectSource::scheduleUpdate()
Schedules a re-rendering of the texture for the next frame.
Use this to update the texture when \l live is false.