From 0241b0e39c4ac259c2336d074f1fa488d0e0ebcc Mon Sep 17 00:00:00 2001 From: Venugopal Shivashankar Date: Wed, 12 Dec 2012 16:35:15 +0100 Subject: Doc: Updated the \example and \snippet paths Also: - Grouped the example docs under one group. i.e. multimedia-examples - Moved the \group page here from the qtdoc repo - Moved the snippets directory under doc from doc/src Change-Id: I28fb81cf910e58101cd601fb4c440b59b0b0366d Reviewed-by: Jerome Pasion --- .../audiodevices/doc/src/audiodevices.qdoc | 4 +- .../audioengine/doc/src/audioengine.qdoc | 4 +- .../multimedia/audioinput/doc/src/audioinput.qdoc | 4 +- .../audiooutput/doc/src/audiooutput.qdoc | 4 +- .../audiorecorder/doc/src/audiorecorder.qdoc | 8 +--- .../doc/src/declarative-radio.qdoc | 7 +++- examples/multimedia/spectrum/doc/src/spectrum.qdoc | 6 +-- examples/multimedia/video/doc/src/qmlvideo.qdoc | 48 +++++++++++----------- examples/multimedia/video/doc/src/qmlvideofx.qdoc | 29 +++++++------ .../multimediawidgets/camera/doc/src/camera.qdoc | 6 +-- .../doc/src/declarative-camera.qdoc | 5 +-- .../multimediawidgets/player/doc/src/player.qdoc | 6 +-- .../doc/src/videographicsitem.qdoc | 4 +- .../videowidget/doc/src/videowidget.qdoc | 4 +- 14 files changed, 67 insertions(+), 72 deletions(-) (limited to 'examples') diff --git a/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc b/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc index d2522f3ae..af51e373f 100644 --- a/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc +++ b/examples/multimedia/audiodevices/doc/src/audiodevices.qdoc @@ -26,9 +26,9 @@ ****************************************************************************/ /*! - \example audiodevices + \example multimedia/audiodevices \title Audio Devices Example - \ingroup audio_examples + \ingroup multimedia_examples \brief The Audio Devices example shows the application of the audio devices APIs diff --git a/examples/multimedia/audioengine/doc/src/audioengine.qdoc b/examples/multimedia/audioengine/doc/src/audioengine.qdoc index bea4d4b57..ba2f17c52 100644 --- a/examples/multimedia/audioengine/doc/src/audioengine.qdoc +++ b/examples/multimedia/audioengine/doc/src/audioengine.qdoc @@ -26,9 +26,9 @@ ****************************************************************************/ /*! - \example audioengine + \example multimedia/audioengine \title AudioEngine Example - \ingroup audioengine_examples + \ingroup multimedia_examples \brief The Audio Engine example demonstrates 3D sound control using the QtAudioEngine API. diff --git a/examples/multimedia/audioinput/doc/src/audioinput.qdoc b/examples/multimedia/audioinput/doc/src/audioinput.qdoc index 4fc7e6e64..ccd4ed269 100644 --- a/examples/multimedia/audioinput/doc/src/audioinput.qdoc +++ b/examples/multimedia/audioinput/doc/src/audioinput.qdoc @@ -26,9 +26,9 @@ ****************************************************************************/ /*! - \example audioinput + \example multimedia/audioinput \title Audio Input Example - \ingroup audio_examples + \ingroup multimedia_examples \brief The Audio Input Example shows the use of the QAudioInput class. The example demonstrates the basic use cases of the QAudioInput class. diff --git a/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc b/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc index c29fcd81d..91c735fa6 100644 --- a/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc +++ b/examples/multimedia/audiooutput/doc/src/audiooutput.qdoc @@ -26,9 +26,9 @@ ****************************************************************************/ /*! - \example audiooutput + \example multimedia/audiooutput \title Audio Output Example - \ingroup audio_examples + \ingroup multimedia_examples \brief The Audio Output Example show the use of the QAudioOutput API. The example demonstrates the basic use cases of the QAudioOutput class. diff --git a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc index 3dea92cac..df3ce1389 100644 --- a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc +++ b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc @@ -26,9 +26,9 @@ ****************************************************************************/ /*! - \example audiorecorder + \example multimedia/audiorecorder \title Audio Recorder Example - \ingroup audio_examples + \ingroup multimedia_examples \brief The Audio Recorder Example shows how to create a simple audio recorder. It demonstrates the discovery of the supported devices and codecs and the use @@ -95,10 +95,6 @@ \code ui->statusbar->showMessage(tr("Recorded %1 sec").arg(duration / 1000)); \endcode - - - - */ diff --git a/examples/multimedia/declarative-radio/doc/src/declarative-radio.qdoc b/examples/multimedia/declarative-radio/doc/src/declarative-radio.qdoc index 8b52e6c71..bf3f39ca0 100644 --- a/examples/multimedia/declarative-radio/doc/src/declarative-radio.qdoc +++ b/examples/multimedia/declarative-radio/doc/src/declarative-radio.qdoc @@ -26,10 +26,13 @@ ****************************************************************************/ /*! - \example declarative-radio + \example multimedia/declarative-radio \title Declarative Radio Example + \brief Demonstrates the radio functionality + \ingroup multimedia_examples - + This examples uses the Qt Multimedia Radio QML type to list the available + channels on the FM frequency. */ diff --git a/examples/multimedia/spectrum/doc/src/spectrum.qdoc b/examples/multimedia/spectrum/doc/src/spectrum.qdoc index 64c6f8364..5e91af439 100644 --- a/examples/multimedia/spectrum/doc/src/spectrum.qdoc +++ b/examples/multimedia/spectrum/doc/src/spectrum.qdoc @@ -26,12 +26,12 @@ ****************************************************************************/ /*! - \example spectrum + \example multimedia/spectrum \title Spectrum Example - \ingroup audio_examples + \ingroup multimedia_examples \brief The Spectrum Example uses a combination multimedia APIs to process microphone input. - The Spectrum Analyzer example shows how the \l{QtMultimedia Module} can be + The Spectrum Analyzer example shows how the \l{Qt Multimedia} module can be used to record and then play back an audio stream. \image spectrum-demo.png diff --git a/examples/multimedia/video/doc/src/qmlvideo.qdoc b/examples/multimedia/video/doc/src/qmlvideo.qdoc index c27ca1bce..359d07156 100644 --- a/examples/multimedia/video/doc/src/qmlvideo.qdoc +++ b/examples/multimedia/video/doc/src/qmlvideo.qdoc @@ -26,9 +26,9 @@ ****************************************************************************/ /*! -\example video/qmlvideo +\example multimedia/video/qmlvideo \title QML Video Example -\ingroup video_examples_qml +\ingroup multimedia_examples \brief The QML Video Example demonstrates the various manipulations (move; resize; rotate; change aspect ratio) which can be applied to QML \l{VideoOutput} @@ -52,15 +52,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 @@ -72,18 +72,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/ideo/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 @@ -94,9 +94,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 @@ -106,35 +106,35 @@ 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 cameracontent -(\l{video/qmlvideo/qml/qmlvideo/CameraBasic.qml}{CameraBasic}). This approach +(\l{multimedia/video/qmlvideo/qml/qmlvideo/VideoBasic.qml}{VideoBasic}) and cameracontent +(\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 -\input examples/video-qml-paint-rate.qdocinc +\input video-qml-paint-rate.qdocinc 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 QmlApplicationViewer \printuntil ; \dots diff --git a/examples/multimedia/video/doc/src/qmlvideofx.qdoc b/examples/multimedia/video/doc/src/qmlvideofx.qdoc index f9b324087..b6535a952 100644 --- a/examples/multimedia/video/doc/src/qmlvideofx.qdoc +++ b/examples/multimedia/video/doc/src/qmlvideofx.qdoc @@ -26,10 +26,9 @@ ****************************************************************************/ /*! -\example video/qmlvideofx +\example multimedia/video/qmlvideofx \title QML Video Shader Effects Example -\ingroup video_examples_qml -\ingroup camera_examples_qml +\ingroup multimedia_examples \brief The QML Video Shader Effects Example shows how \l {ShaderEffect} can be used to apply postprocessing effects, expressed in \c GLSL, to video @@ -135,10 +134,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 @@ -165,10 +164,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 /^\}/ @@ -180,20 +179,20 @@ 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 -\l{video/qmlvideofx/qml/qmlvideofx/EffectSelectionPanel.qml}{EffectSelectionPanel} +\l{multimedia/video/qmlvideofx/qml/qmlvideofx/EffectSelectionPanel.qml}{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 source selection menu: @@ -204,12 +203,12 @@ And here is the effect selection menu: \section1 Calculating and displaying QML painting rate -\input examples/video-qml-paint-rate.qdocinc +\input video-qml-paint-rate.qdocinc 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 QmlApplicationViewer \printuntil ; \dots diff --git a/examples/multimediawidgets/camera/doc/src/camera.qdoc b/examples/multimediawidgets/camera/doc/src/camera.qdoc index c40c25135..15bf9fddf 100644 --- a/examples/multimediawidgets/camera/doc/src/camera.qdoc +++ b/examples/multimediawidgets/camera/doc/src/camera.qdoc @@ -29,14 +29,12 @@ /*! -\example camera +\example multimediawidgets/camera \title Camera Example -\ingroup camera_examples +\ingroup multimedia_examples \brief The Camera Example shows how to use the API to capture a still image or video. - - The Camera Example demonstrates how you can use QtMultimedia to implement some basic Camera functionality to take still images and record video clips with audio. diff --git a/examples/multimediawidgets/declarative-camera/doc/src/declarative-camera.qdoc b/examples/multimediawidgets/declarative-camera/doc/src/declarative-camera.qdoc index 37f35ea26..c98688b00 100644 --- a/examples/multimediawidgets/declarative-camera/doc/src/declarative-camera.qdoc +++ b/examples/multimediawidgets/declarative-camera/doc/src/declarative-camera.qdoc @@ -26,10 +26,9 @@ ****************************************************************************/ /*! -\example declarative-camera +\example multimediawidgets/declarative-camera \title QML Camera Example -\ingroup camera_examples_qml - +\ingroup multimedia_examples \brief The Camera Example shows how to use the API to capture a still image or video. diff --git a/examples/multimediawidgets/player/doc/src/player.qdoc b/examples/multimediawidgets/player/doc/src/player.qdoc index 5e98b912c..5522425c7 100644 --- a/examples/multimediawidgets/player/doc/src/player.qdoc +++ b/examples/multimediawidgets/player/doc/src/player.qdoc @@ -26,10 +26,10 @@ ****************************************************************************/ /*! - \example player + \example multimediawidgets/player \title Media Player Example - \ingroup video_examples - + \ingroup multimedia_examples + \brief Demonstrates the audio and video playback functionality This example creates a simple multimedia player. We can play audio and or video files using various codecs. diff --git a/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc b/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc index c1eb0ccc7..6deca4ce6 100644 --- a/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc +++ b/examples/multimediawidgets/videographicsitem/doc/src/videographicsitem.qdoc @@ -26,9 +26,9 @@ ****************************************************************************/ /*! -\example videographicsitem +\example multimediawidgets/videographicsitem \title Video Graphics Item Example -\ingroup video_examples +\ingroup multimedia_examples \brief This example demonstrates how to stream video on a graphics scene. The Video Graphics Item example shows how to implement a QGraphicsItem that displays video on a diff --git a/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc b/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc index 860cb7ac5..9a95f0ca5 100644 --- a/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc +++ b/examples/multimediawidgets/videowidget/doc/src/videowidget.qdoc @@ -26,9 +26,9 @@ ****************************************************************************/ /*! - \example videowidget + \example multimediawidgets/videowidget \title Video Widget Example - \ingroup video_examples + \ingroup multimedia_examples \brief This example is a simple video player The Video Widget example denonstrates how to implement a video widget using -- cgit v1.2.3