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:
@@ -38,7 +38,7 @@ exampledirs += ../../../examples \
|
||||
snippets
|
||||
|
||||
# Specify example install dir under QT_INSTALL_EXAMPLES
|
||||
examplesinstallpath = qtmultimedia/multimedia
|
||||
examplesinstallpath = qtmultimedia
|
||||
|
||||
headerdirs += ../..
|
||||
|
||||
|
||||
@@ -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
|
||||
instantaneous and an averaged frequency:
|
||||
|
||||
\quotefromfile video/snippets/frequencymonitor/frequencymonitor.h
|
||||
\quotefromfile multimedia/video/snippets/frequencymonitor/frequencymonitor.h
|
||||
\skipto class FrequencyMonitor : public QObject
|
||||
\printuntil Q_OBJECT
|
||||
\skipto Q_PROPERTY(qreal instantaneousFrequency
|
||||
@@ -19,13 +19,13 @@ instantaneous and an averaged frequency:
|
||||
|
||||
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
|
||||
\printuntil }
|
||||
|
||||
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
|
||||
\printuntil id: root
|
||||
\dots
|
||||
|
||||
@@ -81,52 +81,52 @@ For some quick recipes, look at the overviews above and consult this table:
|
||||
\li QSoundEffect
|
||||
\row
|
||||
\li Playing low latency audio
|
||||
\li \l{audioinput},
|
||||
\l{spectrum}
|
||||
\li \l{Audio Input Example}{audioinput},
|
||||
\l{Spectrum Example}{spectrum}
|
||||
\li
|
||||
\li QAudioOutput
|
||||
\row
|
||||
\li Playing encoded audio (MP3, AAC etc)
|
||||
\li \l{player}
|
||||
\li \l{Media Player Example}{player}
|
||||
\li \l Audio, \l {MediaPlayer}
|
||||
\li QMediaPlayer
|
||||
\row
|
||||
\li Accessing raw audio input data
|
||||
\li \l{spectrum},
|
||||
\l{audioinput}
|
||||
\li \l{Spectrum Example}{spectrum},
|
||||
\l{Audio Input Example}{audioinput}
|
||||
\li
|
||||
\li QAudioInput
|
||||
\row
|
||||
\li Recording encoded audio data
|
||||
\li \l{audiorecorder}
|
||||
\li \l{Audio Recorder Example}{audiorecorder}
|
||||
\li
|
||||
\li QAudioRecorder
|
||||
\row
|
||||
\li Discovering raw audio devices
|
||||
\li \l{audiodevices}
|
||||
\li \l{Audio Devices Example}{audiodevices}
|
||||
\li
|
||||
\li QAudioDeviceInfo
|
||||
\row
|
||||
\li Video Playback
|
||||
\li \l{player},
|
||||
\l{video/qmlvideo}{qmlvideo},
|
||||
\l{video/qmlvideofx}{qmlvideofx}
|
||||
\li \l{Media Player Example}{player},
|
||||
\l{QML Video Example}{qmlvideo},
|
||||
\l{QML Video Shader Effects Example}{qmlvideofx}
|
||||
\li \l MediaPlayer, \l VideoOutput, \l Video
|
||||
\li QMediaPlayer, QVideoWidget, QGraphicsVideoItem
|
||||
\row
|
||||
\li Video Processing
|
||||
\li \l {video/qmlvideofx}{qmlvideofx}
|
||||
\li \l {QML Video Example}{qmlvideofx}
|
||||
\li \l {MediaPlayer}, \l VideoOutput
|
||||
\li QMediaPlayer, QAbstractVideoSurface, QVideoFrame
|
||||
\row
|
||||
\li Listening to the radio
|
||||
\li \l {declarative-radio}
|
||||
\li \l {Declarative Radio Example}{declarative-radio}
|
||||
\li \l Radio, \l RadioData
|
||||
\li QRadioTuner, QRadioData
|
||||
\row
|
||||
\li Accessing camera viewfinder
|
||||
\li \l {Camera Example}{camera},
|
||||
\l {declarative-camera}
|
||||
\l {QML Camera Example}{declarative-camera}
|
||||
\li \l Camera, \l VideoOutput
|
||||
\li QCamera, QVideoWidget, QGraphicsVideoItem
|
||||
\row
|
||||
@@ -137,13 +137,13 @@ For some quick recipes, look at the overviews above and consult this table:
|
||||
\row
|
||||
\li Capturing photos
|
||||
\li \l {Camera Example}{camera},
|
||||
\l {declarative-camera}
|
||||
\l {QML Camera Example}{declarative-camera}
|
||||
\li \l Camera
|
||||
\li QCamera, QCameraImageCapture
|
||||
\row
|
||||
\li Capturing movies
|
||||
\li \l {Camera Example}{camera},
|
||||
\l {declarative-camera}
|
||||
\l {QML Camera Example}{declarative-camera}
|
||||
\li \l Camera
|
||||
\li QCamera, QMediaRecorder
|
||||
\row
|
||||
|
||||
@@ -25,12 +25,6 @@
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
/*!
|
||||
\group qml-multimedia
|
||||
\title QML Multimedia Plugin
|
||||
QML Support for the Qt Multimedia API.
|
||||
*/
|
||||
|
||||
/*!
|
||||
\page qml-multimedia.html
|
||||
|
||||
|
||||
@@ -64,8 +64,7 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
\snippet multimedia-snippets/media.cpp Audio recorder inputs
|
||||
|
||||
The \l {audiorecorder}{Audio Recorder} example shows how to use this class
|
||||
in more detail.
|
||||
The \l {Audio Recorder Example} shows how to use this class in more detail.
|
||||
|
||||
\sa QMediaRecorder, QAudioInputSelectorControl
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user