diff options
author | Topi Reinio <topi.reinio@theqtcompany.com> | 2016-01-05 14:55:03 +0100 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@theqtcompany.com> | 2016-01-08 11:47:52 +0000 |
commit | c5f5c7a5f24da3b81f6ac76c3cfcbdfce920df94 (patch) | |
tree | 5a3b8efb137e177c7de46858ecd47f40fcf2c5b7 /src | |
parent | 62268c2d4b4e80ec139e09568e35d585b1f9c62b (diff) |
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>
Diffstat (limited to 'src')
-rw-r--r-- | src/multimedia/doc/qtmultimedia.qdocconf | 2 | ||||
-rw-r--r-- | src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc | 6 | ||||
-rw-r--r-- | src/multimedia/doc/src/multimedia.qdoc | 30 | ||||
-rw-r--r-- | src/multimedia/doc/src/plugins/qml-multimedia.qdoc | 6 | ||||
-rw-r--r-- | src/multimedia/recording/qaudiorecorder.cpp | 3 |
5 files changed, 20 insertions, 27 deletions
diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf index cd16a3f5d..439c11997 100644 --- a/src/multimedia/doc/qtmultimedia.qdocconf +++ b/src/multimedia/doc/qtmultimedia.qdocconf @@ -38,7 +38,7 @@ exampledirs += ../../../examples \ snippets # Specify example install dir under QT_INSTALL_EXAMPLES -examplesinstallpath = qtmultimedia/multimedia +examplesinstallpath = qtmultimedia headerdirs += ../.. diff --git a/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc b/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc index 84098e241..860f14270 100644 --- a/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc +++ b/src/multimedia/doc/src/examples/video-qml-paint-rate.qdocinc @@ -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 diff --git a/src/multimedia/doc/src/multimedia.qdoc b/src/multimedia/doc/src/multimedia.qdoc index 23c2ee431..5849af59d 100644 --- a/src/multimedia/doc/src/multimedia.qdoc +++ b/src/multimedia/doc/src/multimedia.qdoc @@ -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 diff --git a/src/multimedia/doc/src/plugins/qml-multimedia.qdoc b/src/multimedia/doc/src/plugins/qml-multimedia.qdoc index 15c6d3c1d..4cb30a8b8 100644 --- a/src/multimedia/doc/src/plugins/qml-multimedia.qdoc +++ b/src/multimedia/doc/src/plugins/qml-multimedia.qdoc @@ -26,12 +26,6 @@ ****************************************************************************/ /*! - \group qml-multimedia - \title QML Multimedia Plugin - QML Support for the Qt Multimedia API. -*/ - -/*! \page qml-multimedia.html \title Qt Multimedia QML API diff --git a/src/multimedia/recording/qaudiorecorder.cpp b/src/multimedia/recording/qaudiorecorder.cpp index 3c0d1c22d..9750c0ffe 100644 --- a/src/multimedia/recording/qaudiorecorder.cpp +++ b/src/multimedia/recording/qaudiorecorder.cpp @@ -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 */ |