Doc: Fix example paths referred in documentation
authorTopi Reinio <topi.reinio@digia.com>
Fri, 26 Apr 2013 13:50:01 +0000 (15:50 +0200)
committerThe Qt Project <gerrit-noreply@qt-project.org>
Tue, 30 Apr 2013 06:59:32 +0000 (08:59 +0200)
qdocconf files for both Qt Multimedia and Qt Multimedia Widgets already
define the correct example path. This change fixes also the example
documentation to use the correct path, as well as the link to examples
in Multimedia Overview.

Change-Id: I72d75027ee18f6398eb76dc40bcc3d122541b1c9
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
15 files changed:
examples/multimedia/audiodevices/doc/src/audiodevices.qdoc
examples/multimedia/audioengine/doc/src/audioengine.qdoc
examples/multimedia/audioinput/doc/src/audioinput.qdoc
examples/multimedia/audiooutput/doc/src/audiooutput.qdoc
examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc
examples/multimedia/declarative-radio/doc/src/declarative-radio.qdoc
examples/multimedia/spectrum/doc/src/spectrum.qdoc
examples/multimedia/video/doc/src/qmlvideo.qdoc
examples/multimedia/video/doc/src/qmlvideofx.qdoc
examples/multimediawidgets/camera/doc/src/camera.qdoc
examples/multimediawidgets/declarative-camera/doc/src/declarative-camera.qdoc
examples/multimediawidgets/player/doc/src/player.qdoc
examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc
examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc
src/multimedia/doc/src/multimedia.qdoc

index d0b1694..d755844 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \example multimedia/audiodevices
+    \example audiodevices
     \title Audio Devices Example
     \ingroup multimedia_examples
     \brief The Audio Devices example shows the application of the audio devices APIs
index b529458..c83247d 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \example multimedia/audioengine
+    \example audioengine
     \title AudioEngine Example
     \ingroup multimedia_examples
     \brief The Audio Engine example demonstrates 3D sound control using
index 8c4f354..39ef261 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \example multimedia/audioinput
+    \example audioinput
     \title Audio Input Example
     \ingroup multimedia_examples
     \brief The Audio Input Example shows the use of the QAudioInput class.
index 9d028ef..bc79e6a 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \example multimedia/audiooutput
+    \example audiooutput
     \title Audio Output Example
     \ingroup multimedia_examples
     \brief The Audio Output Example show the use of the QAudioOutput API.
index a369337..8453ea3 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \example multimedia/audiorecorder
+    \example audiorecorder
     \title Audio Recorder Example
     \ingroup multimedia_examples
     \brief The Audio Recorder Example shows how to create a simple audio recorder.
index 17870b6..99c4111 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \example multimedia/declarative-radio
+    \example declarative-radio
     \title Declarative Radio Example
     \brief Demonstrates the radio functionality
     \ingroup multimedia_examples
index 4c9ce60..2808389 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \example multimedia/spectrum
+    \example spectrum
     \title Spectrum Example
     \ingroup multimedia_examples
     \brief The Spectrum Example uses a combination multimedia APIs to process microphone input.
index 9a2cb37..1efed80 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-\example multimedia/video/qmlvideo
+\example video/qmlvideo
 \title QML Video Example
 \ingroup multimedia_examples
 
index b2ea128..f4abbc5 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-\example multimedia/video/qmlvideofx
+\example video/qmlvideofx
 \title QML Video Shader Effects Example
 \ingroup multimedia_examples
 
index a7bbf38..d1a855d 100644 (file)
@@ -29,7 +29,7 @@
 
 /*!
 
-\example multimediawidgets/camera
+\example camera
 \title  Camera Example
 \ingroup multimedia_examples
 \brief  The Camera Example shows how to use the API to capture a still image
index de000d8..02e7785 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-\example multimediawidgets/declarative-camera
+\example declarative-camera
 \title QML Camera Example
 \ingroup multimedia_examples
 \brief  The Camera Example shows how to use the API to capture a still image
index 0e7d5dc..7a72309 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \example multimediawidgets/player
+    \example player
     \title Media Player Example
     \ingroup multimedia_examples
     \brief Demonstrates the audio and video playback functionality
index 2b1e44d..3ccdba5 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-\example multimediawidgets/videographicsitem
+\example videographicsitem
 \title Video Graphics Item Example
 \ingroup multimedia_examples
 \brief This example demonstrates how to stream video on a graphics scene.
index 765eb6b..805a830 100644 (file)
@@ -26,7 +26,7 @@
 ****************************************************************************/
 
 /*!
-    \example multimediawidgets/videowidget
+    \example videowidget
     \title Video Widget Example
     \ingroup multimedia_examples
     \brief This example is a simple video player
index d53967e..d934682 100644 (file)
@@ -83,52 +83,52 @@ For some quick recipes, look at the overviews above and consult this table:
         \li QSoundEffect
     \row
         \li Playing low latency audio
-        \li \l{multimedia/audiooutput}{audioinput},
-            \l{multimedia/spectrum}{spectrum}
+        \li \l{audioinput},
+            \l{spectrum}
         \li
         \li QAudioOutput
     \row
         \li Playing encoded audio (MP3, AAC etc)
-        \li \l{multimediawidgets/player}{player}
+        \li \l{player}
         \li \l Audio, \l {MediaPlayer}
         \li QMediaPlayer
     \row
         \li Accessing raw audio input data
-        \li \l{multimedia/spectrum}{spectrum},
-            \l {multimedia/audioinput}{audioinput}
+        \li \l{spectrum},
+            \l{audioinput}
         \li
         \li QAudioInput
     \row
         \li Recording encoded audio data
-        \li \l {multimedia/audiorecorder}{audiorecorder}
+        \li \l{audiorecorder}
         \li
         \li QAudioRecorder
     \row
         \li Discovering raw audio devices
-        \li \l {multimedia/audiodevices}{audiodevices}
+        \li \l{audiodevices}
         \li
         \li QAudioDeviceInfo
     \row
         \li Video Playback
-        \li \l {multimediawidgets/player}{player},
-            \l {multimedia/video/qmlvideo}{qmlvideo},
-            \l{multimedia/video/qmlvideofx}{qmlvideofx}
+        \li \l{player},
+            \l{video/qmlvideo}{qmlvideo},
+            \l{video/qmlvideofx}{qmlvideofx}
         \li \l MediaPlayer, \l VideoOutput, \l Video
         \li QMediaPlayer, QVideoWidget, QGraphicsVideoItem
     \row
         \li Video Processing
-        \li \l {multimedia/video/qmlvideofx}{qmlvideofx}
+        \li \l {video/qmlvideofx}{qmlvideofx}
         \li \l {MediaPlayer}, \l VideoOutput
         \li QMediaPlayer, QAbstractVideoSurface, QVideoFrame
     \row
         \li Listening to the radio
-        \li \l {multimedia/declarative-radio}{declarative-radio}
+        \li \l {declarative-radio}
         \li \l Radio, \l RadioData
         \li QRadioTuner, QRadioData
     \row
         \li Accessing camera viewfinder
         \li \l {Camera Example}{camera},
-            \l {multimediawidgets/declarative-camera}{declarative-camera}
+            \l {declarative-camera}
         \li \l Camera, \l VideoOutput
         \li QCamera, QVideoWidget, QGraphicsVideoItem
     \row
@@ -139,13 +139,13 @@ For some quick recipes, look at the overviews above and consult this table:
     \row
         \li Capturing photos
         \li \l {Camera Example}{camera},
-            \l {multimediawidgets/declarative-camera}{declarative-camera}
+            \l {declarative-camera}
         \li \l Camera
         \li QCamera, QCameraImageCapture
     \row
         \li Capturing movies
         \li \l {Camera Example}{camera},
-            \l {multimediawidgets/declarative-camera}{declarative-camera}
+            \l {declarative-camera}
         \li \l Camera
         \li QCamera, QMediaRecorder
     \row