Doc: Fix documentation warnings
- Fix incorrect paths passed to \example command - Fix resulting linking issues - Fix examplesinstallpath in .qdocconf - Remove unnecessary group definition Change-Id: I72a437ac6d297f3c63d4f29a0e3110971d1e330f Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
This commit is contained in:
Topi Reinio
@@ -26,7 +26,7 @@
|
||||
****************************************************************************/
|
||||
|
||||
/*!
|
||||
\example video/qmlvideo
|
||||
\example multimedia/video/qmlvideo
|
||||
\title QML Video Example
|
||||
\ingroup multimedia_examples
|
||||
\brief Transforming video and camera viewfinder content.
|
||||
@@ -50,15 +50,15 @@ which moves across the \l{VideoOutput} item.
|
||||
|
||||
\section1 Application Structure
|
||||
|
||||
The \l{video/qmlvideo/qml/qmlvideo/main.qml} file creates a UI which includes
|
||||
The \l{multimedia/video/qmlvideo/qml/qmlvideo/main.qml} file creates a UI which includes
|
||||
the following items:
|
||||
|
||||
\list
|
||||
\li Two \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button} instances, each
|
||||
\li Two \l{multimedia/video/qmlvideo/qml/qmlvideo/Button.qml}{Button} instances, each
|
||||
of which displays a filename, and can be used to launch a
|
||||
\l{video/qmlvideo/qml/qmlvideo/FileBrowser.qml}{FileBrowser}
|
||||
\li An exit \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button}
|
||||
\li A \l{video/qmlvideo/qml/qmlvideo/SceneSelectionPanel.qml}{SceneSelectionPanel},
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/FileBrowser.qml}{FileBrowser}
|
||||
\li An exit \l{multimedia/video/qmlvideo/qml/qmlvideo/Button.qml}{Button}
|
||||
\li A \l{multimedia/video/qmlvideo/qml/qmlvideo/SceneSelectionPanel.qml}{SceneSelectionPanel},
|
||||
which is a flickable list displaying the available scenes
|
||||
\li At the lower left, an item which displays the QML repainting rate - the
|
||||
upper number is the instantaneous frame rate and the lower number is the
|
||||
@@ -70,18 +70,18 @@ the following items:
|
||||
Each scene in the flickable list is implemented in its own QML file - for
|
||||
example the video-basic scene (which just displays a static \l{VideoOutput}
|
||||
in the center of the screen) is implemented in the
|
||||
\l{video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic.qml} file. As you
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic.qml} file. As you
|
||||
can see from the code, this makes use of a type of inheritance: a
|
||||
\l{video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic} item ...
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic} item ...
|
||||
|
||||
\quotefromfile video/qmlvideo/qml/qmlvideo/VideoBasic.qml
|
||||
\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml
|
||||
\skipto import
|
||||
\printuntil /^\}/
|
||||
|
||||
... is-a
|
||||
\l{video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} ...
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} ...
|
||||
|
||||
\quotefromfile video/qmlvideo/qml/qmlvideo/SceneBasic.qml
|
||||
\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml
|
||||
\skipto import
|
||||
\printuntil contentType
|
||||
\dots
|
||||
@@ -92,9 +92,9 @@ can see from the code, this makes use of a type of inheritance: a
|
||||
\printuntil /^\}/
|
||||
|
||||
... which is-a
|
||||
\l{video/qmlvideo/qml/qmlvideo/Scene.qml}{Scene}:
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/Scene.qml}{Scene}:
|
||||
|
||||
\quotefromfile video/qmlvideo/qml/qmlvideo/Scene.qml
|
||||
\quotefromfile multimedia/video/qmlvideo/qml/qmlvideo/Scene.qml
|
||||
\skipto import
|
||||
\printuntil root
|
||||
\dots
|
||||
@@ -104,25 +104,25 @@ can see from the code, this makes use of a type of inheritance: a
|
||||
\skipto Button
|
||||
\printuntil /^\}/
|
||||
|
||||
\l{video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} describes the
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/SceneBasic.qml}{SceneBasic} describes the
|
||||
structure and behaviour of the scene, but is agnostic of the type of content
|
||||
which will be displayed - this is abstracted by
|
||||
\l{video/qmlvideo/qml/qmlvideo/Content.qml}{Content}.
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/Content.qml}{Content}.
|
||||
|
||||
This pattern allows us to define a particular use case (in this case, simply
|
||||
display a static piece of content), and then instantiate that use case for
|
||||
both video content
|
||||
(\l{video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic}) and camera content
|
||||
(\l{video/qmlvideo/qml/qmlvideo/CameraBasic.qml}{CameraBasic}). This approach
|
||||
(\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic}) and camera content
|
||||
(\l{multimedia/video/qmlvideo/qml/qmlvideo/CameraBasic.qml}{CameraBasic}). This approach
|
||||
is used to implement many of the other scenes - for example, "repeatedly slide
|
||||
the content from left to right and back again" is implemented by
|
||||
\l{video/qmlvideo/qml/qmlvideo/SceneMove.qml}{SceneMove}, on which
|
||||
\l{video/qmlvideo/qml/qmlvideo/VideoMove.qml}{VideoMove} and
|
||||
\l{video/qmlvideo/qml/qmlvideo/CameraMove.qml}{CameraMove} are based.
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/SceneMove.qml}{SceneMove}, on which
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoMove.qml}{VideoMove} and
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/CameraMove.qml}{CameraMove} are based.
|
||||
|
||||
Depending on the value of the contentType property in the top-level scene
|
||||
instance, the embedded
|
||||
\l{video/qmlvideo/qml/qmlvideo/Content.qml}{Content} item creates either a
|
||||
\l{multimedia/video/qmlvideo/qml/qmlvideo/Content.qml}{Content} item creates either a
|
||||
\l{MediaPlayer} or a \l{Camera} item.
|
||||
|
||||
\section1 Calculating and Displaying QML Painting Rate
|
||||
@@ -132,7 +132,7 @@ instance, the embedded
|
||||
All that remains is to connect the afterRendering() signal of the QQuickView
|
||||
object to a JavaScript function, which will eventually call frequencyItem.notify():
|
||||
|
||||
\quotefromfile video/qmlvideo/main.cpp
|
||||
\quotefromfile multimedia/video/qmlvideo/main.cpp
|
||||
\skipto QGuiApplication
|
||||
\printuntil ;
|
||||
\dots
|
||||
|
||||
@@ -26,7 +26,7 @@
|
||||
****************************************************************************/
|
||||
|
||||
/*!
|
||||
\example video/qmlvideofx
|
||||
\example multimedia/video/qmlvideofx
|
||||
\title QML Video Shader Effects Example
|
||||
\ingroup multimedia_examples
|
||||
|
||||
@@ -128,10 +128,10 @@ types is a bit more complicated, for the following reasons:
|
||||
\endlist
|
||||
|
||||
The abstraction of source item type is achieved by the
|
||||
\l{video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content}, which uses a
|
||||
\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content}, which uses a
|
||||
\l{Loader} to create either a \l{MediaPlayer}, \l{Camera} or \l{Image}:
|
||||
|
||||
\quotefromfile video/qmlvideofx/qml/qmlvideofx/Content.qml
|
||||
\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml
|
||||
\skipto import
|
||||
\printuntil {
|
||||
\dots
|
||||
@@ -158,10 +158,10 @@ The abstraction of source item type is achieved by the
|
||||
\printuntil }
|
||||
|
||||
Each effect is implemented as a QML item which is based on the
|
||||
\l{video/qmlvideofx/qml/qmlvideofx/Effect.qml}{Effect}, which in turn
|
||||
\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml}{Effect}, which in turn
|
||||
is based on the \l{ShaderEffect}:
|
||||
|
||||
\quotefromfile video/qmlvideofx/qml/qmlvideofx/Effect.qml
|
||||
\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml
|
||||
\skipto import
|
||||
\printuntil /^\}/
|
||||
|
||||
@@ -173,19 +173,19 @@ implementation of the pixelation effect. As you can see, the pixelation effect
|
||||
supports one parameter (which controls the pixelation granularity), and states
|
||||
that the divider should be displayed.
|
||||
|
||||
\quotefromfile video/qmlvideofx/qml/qmlvideofx/EffectPixelate.qml
|
||||
\quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/EffectPixelate.qml
|
||||
\skipto import
|
||||
\printuntil /^\}/
|
||||
|
||||
The main.qml file shows a
|
||||
\l{video/qmlvideofx/qml/qmlvideofx/FileOpen.qml}{FileOpen}, which allows
|
||||
\l{multimedia/video/qmlvideofx/qml/qmlvideofx/FileOpen.qml}{FileOpen}, which allows
|
||||
the user to select the input source and an EffectSelectionPanel
|
||||
item, which lists each of the available shader effects. As described above, a
|
||||
\l{video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content} item is used to load the
|
||||
\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Content.qml}{Content} item is used to load the
|
||||
appropriate input and effect type. A
|
||||
\l{video/qmlvideofx/qml/qmlvideofx/Divider.qml}{Divider} item draws the
|
||||
\l{multimedia/video/qmlvideofx/qml/qmlvideofx/Divider.qml}{Divider} item draws the
|
||||
vertical dividing line, which can be dragged left / right by the user. Finally,
|
||||
a \l{video/qmlvideofx/qml/qmlvideofx/ParameterPanel.qml}{ParameterPanel} item
|
||||
a \l{multimedia/video/qmlvideofx/qml/qmlvideofx/ParameterPanel.qml}{ParameterPanel} item
|
||||
renders the sliders corresponding to each effect parameter.
|
||||
|
||||
Here is the effect selection menu:
|
||||
@@ -198,7 +198,7 @@ Here is the effect selection menu:
|
||||
All that remains is to connect the afterRendering() signal of the QQuickView
|
||||
object to a JavaScript function, which will eventually call frequencyItem.notify():
|
||||
|
||||
\quotefromfile video/qmlvideofx/main.cpp
|
||||
\quotefromfile multimedia/video/qmlvideofx/main.cpp
|
||||
\skipto QGuiApplication
|
||||
\printuntil ;
|
||||
\dots
|
||||
|
||||
Reference in New Issue
Block a user