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
2016-01-05 14:55:03 +01:00
committed by Topi Reiniö
parent 62268c2d4b
commit c5f5c7a5f2
19 changed files with 65 additions and 72 deletions

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example audiodevices \example multimedia/audiodevices
\title Audio Devices Example \title Audio Devices Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Testing the available audio devices and their configuration. \brief Testing the available audio devices and their configuration.

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example audioengine \example multimedia/audioengine
\title AudioEngine Example \title AudioEngine Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Enabling 3D sound control using the Qt Audio Engine API. \brief Enabling 3D sound control using the Qt Audio Engine API.

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example audioinput \example multimedia/audioinput
\title Audio Input Example \title Audio Input Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Recording audio using the QAudioInput class \brief Recording audio using the QAudioInput class

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example audiooutput \example multimedia/audiooutput
\title Audio Output Example \title Audio Output Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Enabling audio playback using the QAudioOutput class. \brief Enabling audio playback using the QAudioOutput class.

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example audiorecorder \example multimedia/audiorecorder
\title Audio Recorder Example \title Audio Recorder Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Discovering the available devices and supported codecs. \brief Discovering the available devices and supported codecs.

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example declarative-camera \example multimedia/declarative-camera
\title QML Camera Example \title QML Camera Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief The Camera Example shows how to use the API to capture a still image \brief The Camera Example shows how to use the API to capture a still image

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example declarative-radio \example multimedia/declarative-radio
\title Declarative Radio Example \title Declarative Radio Example
\brief Demonstrates using the Radio QML type from Qt Multimedia. \brief Demonstrates using the Radio QML type from Qt Multimedia.
\ingroup multimedia_examples \ingroup multimedia_examples

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example spectrum \example multimedia/spectrum
\title Spectrum Example \title Spectrum Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Analyzing a raw audio stream using the FFTReal library. \brief Analyzing a raw audio stream using the FFTReal library.

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example video/qmlvideo \example multimedia/video/qmlvideo
\title QML Video Example \title QML Video Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Transforming video and camera viewfinder content. \brief Transforming video and camera viewfinder content.
@@ -50,15 +50,15 @@ which moves across the \l{VideoOutput} item.
\section1 Application Structure \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: the following items:
\list \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 of which displays a filename, and can be used to launch a
\l{video/qmlvideo/qml/qmlvideo/FileBrowser.qml}{FileBrowser} \l{multimedia/video/qmlvideo/qml/qmlvideo/FileBrowser.qml}{FileBrowser}
\li An exit \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button} \li An exit \l{multimedia/video/qmlvideo/qml/qmlvideo/Button.qml}{Button}
\li A \l{video/qmlvideo/qml/qmlvideo/SceneSelectionPanel.qml}{SceneSelectionPanel}, \li A \l{multimedia/video/qmlvideo/qml/qmlvideo/SceneSelectionPanel.qml}{SceneSelectionPanel},
which is a flickable list displaying the available scenes which is a flickable list displaying the available scenes
\li At the lower left, an item which displays the QML repainting rate - the \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 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 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} example the video-basic scene (which just displays a static \l{VideoOutput}
in the center of the screen) is implemented in the 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 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 \skipto import
\printuntil /^\}/ \printuntil /^\}/
... is-a ... 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 \skipto import
\printuntil contentType \printuntil contentType
\dots \dots
@@ -92,9 +92,9 @@ can see from the code, this makes use of a type of inheritance: a
\printuntil /^\}/ \printuntil /^\}/
... which is-a ... 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 \skipto import
\printuntil root \printuntil root
\dots \dots
@@ -104,25 +104,25 @@ can see from the code, this makes use of a type of inheritance: a
\skipto Button \skipto Button
\printuntil /^\}/ \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 structure and behaviour of the scene, but is agnostic of the type of content
which will be displayed - this is abstracted by 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 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 display a static piece of content), and then instantiate that use case for
both video content both video content
(\l{video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic}) and camera content (\l{multimedia/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/CameraBasic.qml}{CameraBasic}). This approach
is used to implement many of the other scenes - for example, "repeatedly slide 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 the content from left to right and back again" is implemented by
\l{video/qmlvideo/qml/qmlvideo/SceneMove.qml}{SceneMove}, on which \l{multimedia/video/qmlvideo/qml/qmlvideo/SceneMove.qml}{SceneMove}, on which
\l{video/qmlvideo/qml/qmlvideo/VideoMove.qml}{VideoMove} and \l{multimedia/video/qmlvideo/qml/qmlvideo/VideoMove.qml}{VideoMove} and
\l{video/qmlvideo/qml/qmlvideo/CameraMove.qml}{CameraMove} are based. \l{multimedia/video/qmlvideo/qml/qmlvideo/CameraMove.qml}{CameraMove} are based.
Depending on the value of the contentType property in the top-level scene Depending on the value of the contentType property in the top-level scene
instance, the embedded 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. \l{MediaPlayer} or a \l{Camera} item.
\section1 Calculating and Displaying QML Painting Rate \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 All that remains is to connect the afterRendering() signal of the QQuickView
object to a JavaScript function, which will eventually call frequencyItem.notify(): object to a JavaScript function, which will eventually call frequencyItem.notify():
\quotefromfile video/qmlvideo/main.cpp \quotefromfile multimedia/video/qmlvideo/main.cpp
\skipto QGuiApplication \skipto QGuiApplication
\printuntil ; \printuntil ;
\dots \dots

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example video/qmlvideofx \example multimedia/video/qmlvideofx
\title QML Video Shader Effects Example \title QML Video Shader Effects Example
\ingroup multimedia_examples \ingroup multimedia_examples
@@ -128,10 +128,10 @@ types is a bit more complicated, for the following reasons:
\endlist \endlist
The abstraction of source item type is achieved by the 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}: \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 \skipto import
\printuntil { \printuntil {
\dots \dots
@@ -158,10 +158,10 @@ The abstraction of source item type is achieved by the
\printuntil } \printuntil }
Each effect is implemented as a QML item which is based on the 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}: is based on the \l{ShaderEffect}:
\quotefromfile video/qmlvideofx/qml/qmlvideofx/Effect.qml \quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/Effect.qml
\skipto import \skipto import
\printuntil /^\}/ \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 supports one parameter (which controls the pixelation granularity), and states
that the divider should be displayed. that the divider should be displayed.
\quotefromfile video/qmlvideofx/qml/qmlvideofx/EffectPixelate.qml \quotefromfile multimedia/video/qmlvideofx/qml/qmlvideofx/EffectPixelate.qml
\skipto import \skipto import
\printuntil /^\}/ \printuntil /^\}/
The main.qml file shows a 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 the user to select the input source and an EffectSelectionPanel
item, which lists each of the available shader effects. As described above, a 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 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, 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. renders the sliders corresponding to each effect parameter.
Here is the effect selection menu: 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 All that remains is to connect the afterRendering() signal of the QQuickView
object to a JavaScript function, which will eventually call frequencyItem.notify(): object to a JavaScript function, which will eventually call frequencyItem.notify():
\quotefromfile video/qmlvideofx/main.cpp \quotefromfile multimedia/video/qmlvideofx/main.cpp
\skipto QGuiApplication \skipto QGuiApplication
\printuntil ; \printuntil ;
\dots \dots

View File

@@ -29,7 +29,7 @@
/*! /*!
\example camera \example multimediawidgets/camera
\title Camera Example \title Camera Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief The Camera Example shows how to use the API to capture a still image \brief The Camera Example shows how to use the API to capture a still image

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example player \example multimediawidgets/player
\title Media Player Example \title Media Player Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Playing audio and video. \brief Playing audio and video.

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example videographicsitem \example multimediawidgets/videographicsitem
\title Video Graphics Item Example \title Video Graphics Item Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Streaming video on a graphics scene. \brief Streaming video on a graphics scene.

View File

@@ -26,7 +26,7 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\example videowidget \example multimediawidgets/videowidget
\title Video Widget Example \title Video Widget Example
\ingroup multimedia_examples \ingroup multimedia_examples
\brief Implementing a video player widget. \brief Implementing a video player widget.

View File

@@ -38,7 +38,7 @@ exampledirs += ../../../examples \
snippets snippets
# Specify example install dir under QT_INSTALL_EXAMPLES # Specify example install dir under QT_INSTALL_EXAMPLES
examplesinstallpath = qtmultimedia/multimedia examplesinstallpath = qtmultimedia
headerdirs += ../.. headerdirs += ../..

View File

@@ -2,7 +2,7 @@ The QML painting rate is calculated by the FrequencyMonitor class, which
turns a stream of events (received via the notify() slot), into an turns a stream of events (received via the notify() slot), into an
instantaneous and an averaged frequency: instantaneous and an averaged frequency:
\quotefromfile video/snippets/frequencymonitor/frequencymonitor.h \quotefromfile multimedia/video/snippets/frequencymonitor/frequencymonitor.h
\skipto class FrequencyMonitor : public QObject \skipto class FrequencyMonitor : public QObject
\printuntil Q_OBJECT \printuntil Q_OBJECT
\skipto Q_PROPERTY(qreal instantaneousFrequency \skipto Q_PROPERTY(qreal instantaneousFrequency
@@ -19,13 +19,13 @@ instantaneous and an averaged frequency:
The FrequencyMonitor class is exposed to QML like this The FrequencyMonitor class is exposed to QML like this
\quotefromfile video/snippets/frequencymonitor/frequencymonitordeclarative.cpp \quotefromfile multimedia/video/snippets/frequencymonitor/frequencymonitordeclarative.cpp
\skipto FrequencyMonitor::qmlRegisterType \skipto FrequencyMonitor::qmlRegisterType
\printuntil } \printuntil }
and its data is displayed by defining a QML item called FrequencyItem, like this: and its data is displayed by defining a QML item called FrequencyItem, like this:
\quotefromfile video/snippets/frequencymonitor/qml/frequencymonitor/FrequencyItem.qml \quotefromfile multimedia/video/snippets/frequencymonitor/qml/frequencymonitor/FrequencyItem.qml
\skipto import FrequencyMonitor \skipto import FrequencyMonitor
\printuntil id: root \printuntil id: root
\dots \dots

View File

@@ -81,52 +81,52 @@ For some quick recipes, look at the overviews above and consult this table:
\li QSoundEffect \li QSoundEffect
\row \row
\li Playing low latency audio \li Playing low latency audio
\li \l{audioinput}, \li \l{Audio Input Example}{audioinput},
\l{spectrum} \l{Spectrum Example}{spectrum}
\li \li
\li QAudioOutput \li QAudioOutput
\row \row
\li Playing encoded audio (MP3, AAC etc) \li Playing encoded audio (MP3, AAC etc)
\li \l{player} \li \l{Media Player Example}{player}
\li \l Audio, \l {MediaPlayer} \li \l Audio, \l {MediaPlayer}
\li QMediaPlayer \li QMediaPlayer
\row \row
\li Accessing raw audio input data \li Accessing raw audio input data
\li \l{spectrum}, \li \l{Spectrum Example}{spectrum},
\l{audioinput} \l{Audio Input Example}{audioinput}
\li \li
\li QAudioInput \li QAudioInput
\row \row
\li Recording encoded audio data \li Recording encoded audio data
\li \l{audiorecorder} \li \l{Audio Recorder Example}{audiorecorder}
\li \li
\li QAudioRecorder \li QAudioRecorder
\row \row
\li Discovering raw audio devices \li Discovering raw audio devices
\li \l{audiodevices} \li \l{Audio Devices Example}{audiodevices}
\li \li
\li QAudioDeviceInfo \li QAudioDeviceInfo
\row \row
\li Video Playback \li Video Playback
\li \l{player}, \li \l{Media Player Example}{player},
\l{video/qmlvideo}{qmlvideo}, \l{QML Video Example}{qmlvideo},
\l{video/qmlvideofx}{qmlvideofx} \l{QML Video Shader Effects Example}{qmlvideofx}
\li \l MediaPlayer, \l VideoOutput, \l Video \li \l MediaPlayer, \l VideoOutput, \l Video
\li QMediaPlayer, QVideoWidget, QGraphicsVideoItem \li QMediaPlayer, QVideoWidget, QGraphicsVideoItem
\row \row
\li Video Processing \li Video Processing
\li \l {video/qmlvideofx}{qmlvideofx} \li \l {QML Video Example}{qmlvideofx}
\li \l {MediaPlayer}, \l VideoOutput \li \l {MediaPlayer}, \l VideoOutput
\li QMediaPlayer, QAbstractVideoSurface, QVideoFrame \li QMediaPlayer, QAbstractVideoSurface, QVideoFrame
\row \row
\li Listening to the radio \li Listening to the radio
\li \l {declarative-radio} \li \l {Declarative Radio Example}{declarative-radio}
\li \l Radio, \l RadioData \li \l Radio, \l RadioData
\li QRadioTuner, QRadioData \li QRadioTuner, QRadioData
\row \row
\li Accessing camera viewfinder \li Accessing camera viewfinder
\li \l {Camera Example}{camera}, \li \l {Camera Example}{camera},
\l {declarative-camera} \l {QML Camera Example}{declarative-camera}
\li \l Camera, \l VideoOutput \li \l Camera, \l VideoOutput
\li QCamera, QVideoWidget, QGraphicsVideoItem \li QCamera, QVideoWidget, QGraphicsVideoItem
\row \row
@@ -137,13 +137,13 @@ For some quick recipes, look at the overviews above and consult this table:
\row \row
\li Capturing photos \li Capturing photos
\li \l {Camera Example}{camera}, \li \l {Camera Example}{camera},
\l {declarative-camera} \l {QML Camera Example}{declarative-camera}
\li \l Camera \li \l Camera
\li QCamera, QCameraImageCapture \li QCamera, QCameraImageCapture
\row \row
\li Capturing movies \li Capturing movies
\li \l {Camera Example}{camera}, \li \l {Camera Example}{camera},
\l {declarative-camera} \l {QML Camera Example}{declarative-camera}
\li \l Camera \li \l Camera
\li QCamera, QMediaRecorder \li QCamera, QMediaRecorder
\row \row

View File

@@ -25,12 +25,6 @@
** **
****************************************************************************/ ****************************************************************************/
/*!
\group qml-multimedia
\title QML Multimedia Plugin
QML Support for the Qt Multimedia API.
*/
/*! /*!
\page qml-multimedia.html \page qml-multimedia.html

View File

@@ -64,8 +64,7 @@ QT_BEGIN_NAMESPACE
\snippet multimedia-snippets/media.cpp Audio recorder inputs \snippet multimedia-snippets/media.cpp Audio recorder inputs
The \l {audiorecorder}{Audio Recorder} example shows how to use this class The \l {Audio Recorder Example} shows how to use this class in more detail.
in more detail.
\sa QMediaRecorder, QAudioInputSelectorControl \sa QMediaRecorder, QAudioInputSelectorControl
*/ */