summaryrefslogtreecommitdiffstats
path: root/src/imports
diff options
context:
space:
mode:
authorCasper van Donderen <casper.vandonderen@nokia.com>2012-03-01 19:02:20 +0100
committerQt by Nokia <qt-info@nokia.com>2012-03-13 15:27:31 +0100
commitc051ea15c75851132d08f22825d84d4ea3f49241 (patch)
treeea3aa28296355f313d204f6e190f74cfd87dee0a /src/imports
parentdc5c8d1099ac851b51accf5f87c5be4fc1610c1a (diff)
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold and list items. This change applies that change in QDoc to the actual documentation. Task-number: QTBUG-24578 Change-Id: Iae34eb8f2233dd9dbec79e7ab3c324f3f505b4cc Reviewed-by: Jerome Pasion <jerome.pasion@nokia.com>
Diffstat (limited to 'src/imports')
-rw-r--r--src/imports/folderlistmodel/qdeclarativefolderlistmodel.cpp16
-rw-r--r--src/imports/gestures/qdeclarativegesturearea.cpp34
-rw-r--r--src/imports/particles/qdeclarativeparticles.cpp2
-rw-r--r--src/imports/shaders/shadereffectitem.cpp54
-rw-r--r--src/imports/shaders/shadereffectsource.cpp10
5 files changed, 58 insertions, 58 deletions
diff --git a/src/imports/folderlistmodel/qdeclarativefolderlistmodel.cpp b/src/imports/folderlistmodel/qdeclarativefolderlistmodel.cpp
index a16deb7f..6f5ddee6 100644
--- a/src/imports/folderlistmodel/qdeclarativefolderlistmodel.cpp
+++ b/src/imports/folderlistmodel/qdeclarativefolderlistmodel.cpp
@@ -104,15 +104,15 @@ public:
\e{Elements in the Qt.labs module are not guaranteed to remain compatible
in future versions.}
- \bold{import Qt.labs.folderlistmodel 1.0}
+ \b{import Qt.labs.folderlistmodel 1.0}
The \l folder property specifies the folder to access. Information about the
files and directories in the folder is supplied via the model's interface.
Components access names and paths via the following roles:
\list
- \o fileName
- \o filePath
+ \li fileName
+ \li filePath
\endlist
Additionally a file entry can be differentiated from a folder entry via the
@@ -303,11 +303,11 @@ void QDeclarativeFolderListModel::componentComplete()
The \a sortField property contains field to use for sorting. sortField
may be one of:
\list
- \o Unsorted - no sorting is applied. The order is system default.
- \o Name - sort by filename
- \o Time - sort by time modified
- \o Size - sort by file size
- \o Type - sort by file type (extension)
+ \li Unsorted - no sorting is applied. The order is system default.
+ \li Name - sort by filename
+ \li Time - sort by time modified
+ \li Size - sort by file size
+ \li Type - sort by file type (extension)
\endlist
\sa sortReversed
diff --git a/src/imports/gestures/qdeclarativegesturearea.cpp b/src/imports/gestures/qdeclarativegesturearea.cpp
index afddba62..46d6db2e 100644
--- a/src/imports/gestures/qdeclarativegesturearea.cpp
+++ b/src/imports/gestures/qdeclarativegesturearea.cpp
@@ -113,23 +113,23 @@ public:
properties of the gesture.
\table
- \header \o Signal \o Type \o Property \o Description
- \row \o onTap \o point \o position \o the position of the tap
- \row \o onTapAndHold \o point \o position \o the position of the tap
- \row \o onPan \o real \o acceleration \o the acceleration of the pan
- \row \o onPan \o point \o delta \o the offset from the previous input position to the current input
- \row \o onPan \o point \o offset \o the total offset from the first input position to the current input position
- \row \o onPan \o point \o lastOffset \o the previous value of offset
- \row \o onPinch \o point \o centerPoint \o the midpoint between the two input points
- \row \o onPinch \o point \o lastCenterPoint \o the previous value of centerPoint
- \row \o onPinch \o point \o startCenterPoint \o the first value of centerPoint
- \row \o onPinch \o real \o rotationAngle \o the angle covered by the gesture motion
- \row \o onPinch \o real \o lastRotationAngle \o the previous value of rotationAngle
- \row \o onPinch \o real \o totalRotationAngle \o the complete angle covered by the gesture
- \row \o onPinch \o real \o scaleFactor \o the change in distance between the two input points
- \row \o onPinch \o real \o lastScaleFactor \o the previous value of scaleFactor
- \row \o onPinch \o real \o totalScaleFactor \o the complete scale factor of the gesture
- \row \o onSwipe \o real \o swipeAngle \o the angle of the swipe
+ \header \li Signal \li Type \li Property \li Description
+ \row \li onTap \li point \li position \li the position of the tap
+ \row \li onTapAndHold \li point \li position \li the position of the tap
+ \row \li onPan \li real \li acceleration \li the acceleration of the pan
+ \row \li onPan \li point \li delta \li the offset from the previous input position to the current input
+ \row \li onPan \li point \li offset \li the total offset from the first input position to the current input position
+ \row \li onPan \li point \li lastOffset \li the previous value of offset
+ \row \li onPinch \li point \li centerPoint \li the midpoint between the two input points
+ \row \li onPinch \li point \li lastCenterPoint \li the previous value of centerPoint
+ \row \li onPinch \li point \li startCenterPoint \li the first value of centerPoint
+ \row \li onPinch \li real \li rotationAngle \li the angle covered by the gesture motion
+ \row \li onPinch \li real \li lastRotationAngle \li the previous value of rotationAngle
+ \row \li onPinch \li real \li totalRotationAngle \li the complete angle covered by the gesture
+ \row \li onPinch \li real \li scaleFactor \li the change in distance between the two input points
+ \row \li onPinch \li real \li lastScaleFactor \li the previous value of scaleFactor
+ \row \li onPinch \li real \li totalScaleFactor \li the complete scale factor of the gesture
+ \row \li onSwipe \li real \li swipeAngle \li the angle of the swipe
\endtable
Custom gestures, handled by onGesture, will have custom properties.
diff --git a/src/imports/particles/qdeclarativeparticles.cpp b/src/imports/particles/qdeclarativeparticles.cpp
index f66a9723..87b97d38 100644
--- a/src/imports/particles/qdeclarativeparticles.cpp
+++ b/src/imports/particles/qdeclarativeparticles.cpp
@@ -616,7 +616,7 @@ void QDeclarativeParticlesPrivate::updateOpacity(QDeclarativeParticle &p, int ag
\brief The Particles object generates and moves particles.
\inherits Item
- Particles are available in the \bold{Qt.labs.particles 1.0} module.
+ Particles are available in the \b{Qt.labs.particles 1.0} module.
\e {Elements in the Qt.labs module are not guaranteed to remain compatible
in future versions.}
diff --git a/src/imports/shaders/shadereffectitem.cpp b/src/imports/shaders/shadereffectitem.cpp
index ac5a985e..9c25aa78 100644
--- a/src/imports/shaders/shadereffectitem.cpp
+++ b/src/imports/shaders/shadereffectitem.cpp
@@ -76,7 +76,7 @@ static const char qt_emptyAttributeName[] = "";
\brief The ShaderEffectItem object alters the output of given item with OpenGL shaders.
\inherits Item
- ShaderEffectItem is available in the \bold{Qt.labs.shaders 1.0} module.
+ ShaderEffectItem is available in the \b{Qt.labs.shaders 1.0} module.
\e {Elements in the Qt.labs module are not guaranteed to remain compatible
in future versions.}
@@ -99,15 +99,15 @@ static const char qt_emptyAttributeName[] = "";
A standard set of vertex attributes are provided for the shaders:
\list
- \o qt_Vertex - The primary position of the vertex.
- \o qt_MultiTexCoord0 - The texture co-ordinate at each vertex for texture unit 0.
+ \li qt_Vertex - The primary position of the vertex.
+ \li qt_MultiTexCoord0 - The texture co-ordinate at each vertex for texture unit 0.
\endlist
Additionally following uniforms are available for shaders:
\list
- \o qt_Opacity - Effective opacity of the item.
- \o qt_ModelViewProjectionMatrix - current 4x4 transformation matrix of the item.
+ \li qt_Opacity - Effective opacity of the item.
+ \li qt_ModelViewProjectionMatrix - current 4x4 transformation matrix of the item.
\endlist
Furthermore, it is possible to utilize automatic QML propertybinding into vertex- and fragment shader
@@ -115,38 +115,38 @@ static const char qt_emptyAttributeName[] = "";
\table
\header
- \o QML property
- \o GLSL uniform
+ \li QML property
+ \li GLSL uniform
\row
- \o property double foo: 1.0
- \o uniform highp float foo
+ \li property double foo: 1.0
+ \li uniform highp float foo
\row
- \o property real foo: 1.0
- \o uniform highp float foo
+ \li property real foo: 1.0
+ \li uniform highp float foo
\row
- \o property bool foo: true
- \o uniform bool foo
+ \li property bool foo: true
+ \li uniform bool foo
\row
- \o property int foo: 1
- \o uniform int foo
+ \li property int foo: 1
+ \li uniform int foo
\row
- \o property variant foo: Qt.point(1,1)
- \o uniform highp vec2 foo
+ \li property variant foo: Qt.point(1,1)
+ \li uniform highp vec2 foo
\row
- \o property variant foo: Qt.size(1, 1)
- \o uniform highp vec2 foo
+ \li property variant foo: Qt.size(1, 1)
+ \li uniform highp vec2 foo
\row
- \o property variant foo: Qt.rect(1, 1, 2, 2)
- \o uniform highp vec4 foo
+ \li property variant foo: Qt.rect(1, 1, 2, 2)
+ \li uniform highp vec4 foo
\row
- \o property color foo: "#00000000"
- \o uniform lowp vec4 foo
+ \li property color foo: "#00000000"
+ \li uniform lowp vec4 foo
\row
- \o property variant foo: Qt.vector3d(1.0, 2.0, 0.0)
- \o uniform highp vec3 foo
+ \li property variant foo: Qt.vector3d(1.0, 2.0, 0.0)
+ \li uniform highp vec3 foo
\row
- \o property variant foo: ShaderEffectSource { SourceItem: bar }
- \o uniform lowp sampler2D foo
+ \li property variant foo: ShaderEffectSource { SourceItem: bar }
+ \li uniform lowp sampler2D foo
\endtable
\note
The uniform precision definitions in the above table are not strict, it is possible to choose the uniform
diff --git a/src/imports/shaders/shadereffectsource.cpp b/src/imports/shaders/shadereffectsource.cpp
index fb333183..57e0f43b 100644
--- a/src/imports/shaders/shadereffectsource.cpp
+++ b/src/imports/shaders/shadereffectsource.cpp
@@ -51,7 +51,7 @@
\ingroup qml-shader-elements
\brief The ShaderEffectSource object encapsulates the source content for the ShaderEffectItem.
- ShaderEffectSource is available in the \bold{Qt.labs.shaders 1.0} module.
+ ShaderEffectSource is available in the \b{Qt.labs.shaders 1.0} module.
\e {Elements in the Qt.labs module are not guaranteed to remain compatible
in future versions.}
@@ -241,10 +241,10 @@ void ShaderEffectSource::setHideSource(bool hide)
This property defines the wrap parameter for the source after it has been mapped as a texture.
\list
- \o ShaderEffectSource.ClampToEdge - Causes texturecoordinates to be clamped to the range [ 1/2*N , 1 - 1/2*N ], where N is the texture width.
- \o ShaderEffectSource.RepeatHorizontally - Causes the integer part of the horizontal texturecoordinate to be ignored; the GL uses only the fractional part, thereby creating a horizontal repeating pattern.
- \o ShaderEffectSource.RepeatVertically - Causes the integer part of the vertical texturecoordinate to be ignored; the GL uses only the fractional part, thereby creating a vertical repeating pattern.
- \o ShaderEffectSource.Repeat - Causes the integer part of both the horizontal and vertical texturecoordinates to be ignored; the GL uses only the fractional part, thereby creating a repeating pattern.
+ \li ShaderEffectSource.ClampToEdge - Causes texturecoordinates to be clamped to the range [ 1/2*N , 1 - 1/2*N ], where N is the texture width.
+ \li ShaderEffectSource.RepeatHorizontally - Causes the integer part of the horizontal texturecoordinate to be ignored; the GL uses only the fractional part, thereby creating a horizontal repeating pattern.
+ \li ShaderEffectSource.RepeatVertically - Causes the integer part of the vertical texturecoordinate to be ignored; the GL uses only the fractional part, thereby creating a vertical repeating pattern.
+ \li ShaderEffectSource.Repeat - Causes the integer part of both the horizontal and vertical texturecoordinates to be ignored; the GL uses only the fractional part, thereby creating a repeating pattern.
\endlist
The default value is ClampToEdge.