diff options
author | Casper van Donderen <casper.vandonderen@nokia.com> | 2012-03-01 18:50:38 +0100 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2012-03-02 04:02:43 +0100 |
commit | d1b6bf5fac54a39d911079ba792ca95424c5c70c (patch) | |
tree | eccc1344c41fe509fa5f22a972d5b4decad10f85 /doc/src | |
parent | 3d0a14efceea7b4faabc73f52a1c0e74230d24d2 (diff) | |
download | qtmultimedia-d1b6bf5fac54a39d911079ba792ca95424c5c70c.tar.gz |
Remove the usage of deprecated qdoc macros.
QDoc now has support for Doxygen style commands for italics, bold
and list items. This change applies that change in QDoc to the
actual documentation.
Task-number: QTBUG-24578
Change-Id: Iec1c616e0d9a915a31a661916805916e19495dc9
Reviewed-by: Michael Goddard <michael.goddard@nokia.com>
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/audioengineoverview.qdoc | 22 | ||||
-rw-r--r-- | doc/src/audiooverview.qdoc | 14 | ||||
-rw-r--r-- | doc/src/cameraoverview.qdoc | 6 | ||||
-rw-r--r-- | doc/src/changes.qdoc | 62 | ||||
-rw-r--r-- | doc/src/examples/qmlvideo.qdoc | 8 | ||||
-rw-r--r-- | doc/src/examples/qmlvideofx.qdoc | 6 | ||||
-rw-r--r-- | doc/src/multimedia.qdoc | 138 | ||||
-rw-r--r-- | doc/src/multimediabackend.qdoc | 6 | ||||
-rw-r--r-- | doc/src/plugins/qml-multimedia.qdoc | 84 | ||||
-rw-r--r-- | doc/src/radiooverview.qdoc | 4 | ||||
-rw-r--r-- | doc/src/videooverview.qdoc | 16 |
11 files changed, 183 insertions, 183 deletions
diff --git a/doc/src/audioengineoverview.qdoc b/doc/src/audioengineoverview.qdoc index bc979f6ca..888293e82 100644 --- a/doc/src/audioengineoverview.qdoc +++ b/doc/src/audioengineoverview.qdoc @@ -43,7 +43,7 @@ events and managed by QtAudioEngine or controlled by explicitly defining a \l So for easier qml bindings. QtAudioEngine elements can be accessed through importing the -\bold{QtAudioEngine 1.0} module. +\b{QtAudioEngine 1.0} module. \qml import QtQuick 2.0 @@ -55,7 +55,7 @@ AudioEngine { \section1 Examples \list - \o \l {AudioEngine Example}{Audio Engine} + \li \l {AudioEngine Example}{Audio Engine} \endlist \section1 Reference Documentation @@ -63,15 +63,15 @@ AudioEngine { \section2 QML Elements \list - \o \l AudioEngine - \o \l AudioSample - \o \l AudioCategory - \o \l AttenuationModelLinear - \o \l AttenuationModelInverse - \o \l Sound - \o \l PlayVariation - \o \l AudioListener - \o \l SoundInstance + \li \l AudioEngine + \li \l AudioSample + \li \l AudioCategory + \li \l AttenuationModelLinear + \li \l AttenuationModelInverse + \li \l Sound + \li \l PlayVariation + \li \l AudioListener + \li \l SoundInstance \endlist diff --git a/doc/src/audiooverview.qdoc b/doc/src/audiooverview.qdoc index d9872ffcc..902e3db99 100644 --- a/doc/src/audiooverview.qdoc +++ b/doc/src/audiooverview.qdoc @@ -144,11 +144,11 @@ the supported devices and codecs and the use of recording functions in the QAudioRecorder class. \list - \o \l audiodevices - \o \l audioinput - \o \l audiooutput - \o \l audiorecorder - \o \l spectrum + \li \l audiodevices + \li \l audioinput + \li \l audiooutput + \li \l audiorecorder + \li \l spectrum \endlist QML Examples: @@ -163,8 +163,8 @@ QML Examples: \section2 QML Elements \list - \o \l Audio - \o \l MediaPlayer + \li \l Audio + \li \l MediaPlayer \endlist */ diff --git a/doc/src/cameraoverview.qdoc b/doc/src/cameraoverview.qdoc index 27bd8f0f7..9af9daae2 100644 --- a/doc/src/cameraoverview.qdoc +++ b/doc/src/cameraoverview.qdoc @@ -242,13 +242,13 @@ There are both C++ and QML examples available. C++ Examples: \list - \o \l Camera + \li \l Camera \endlist QML Examples: \list - \o \l declarative-camera - \o \l qmlvideofx + \li \l declarative-camera + \li \l qmlvideofx \endlist \section1 Reference Documentation diff --git a/doc/src/changes.qdoc b/doc/src/changes.qdoc index 46511bc67..b895f219e 100644 --- a/doc/src/changes.qdoc +++ b/doc/src/changes.qdoc @@ -47,15 +47,15 @@ are now in a new library (QtMultimediaWidgets). There are a number of new features in QtMultimedia 5.0: \list -\o Expanded QML API -\o New \l QAudioRecorder class -\o Volume support for QAudioOutput and QAudioInput -\o More examples and documentation -\o QML \l Torch class -\o QSound moved from QtGui to QtMultimedia -\o QSoundEffect available to C++ now, as well as QML -\o FM Radio Data System classes and elements now available (\l QRadioData, \l RadioData) -\o Various other API improvements and bugfixes +\li Expanded QML API +\li New \l QAudioRecorder class +\li Volume support for QAudioOutput and QAudioInput +\li More examples and documentation +\li QML \l Torch class +\li QSound moved from QtGui to QtMultimedia +\li QSoundEffect available to C++ now, as well as QML +\li FM Radio Data System classes and elements now available (\l QRadioData, \l RadioData) +\li Various other API improvements and bugfixes \endlist \section1 Removed features @@ -65,11 +65,11 @@ been removed. \table 70% \header - \o Removed feature - \o Notes + \li Removed feature + \li Notes \row - \o QMediaImageViewer - \o This class (and related controls and services) were removed since + \li QMediaImageViewer + \li This class (and related controls and services) were removed since their functionality was not suitable for many applications \endtable @@ -82,11 +82,11 @@ they are documented elsewhere. \table 70% \header - \o Changed feature - \o Notes + \li Changed feature + \li Notes \row - \o QMake .pro file changes - \o If you've used QtMultimediaKit in the past, you needed to put + \li QMake .pro file changes + \li If you've used QtMultimediaKit in the past, you needed to put \code CONFIG += mobility MOBILITY += multimedia @@ -101,8 +101,8 @@ they are documented elsewhere. \endcode if you need to use the widget classes. \row - \o Namespace changes - \o For QtMultimediaKit the majority of the classes were in the + \li Namespace changes + \li For QtMultimediaKit the majority of the classes were in the normal Qt namespace (usually nothing, unless built specially). There was a QtMultimediaKit namespace for several enumerations. This namespace has now changed to QtMultimedia, so if you've used one of the @@ -111,41 +111,41 @@ they are documented elsewhere. search and replace on QtMultimediaKit (to replace it with QtMultimedia) will go a long way with porting your code. \row - \o Meta-data enumeration changes - \o In QtMultimediaKit the available meta-data keys were in an enumeration + \li Meta-data enumeration changes + \li In QtMultimediaKit the available meta-data keys were in an enumeration in the QtMultimediaKit namespace. These meta-data keys have been changed to string literals in the QtMultimedia::MetaData namespace - generally your source code will mostly be compatible unless you have created variables or parameters with the QtMultimedia::MetaData type - you should replace these with QStrings. \row - \o Meta-data method changes - \o In QtMultimediaKit the available meta-data was split between methods to + \li Meta-data method changes + \li In QtMultimediaKit the available meta-data was split between methods to access standard, pre-defined keys, and methods to access extensible free form key meta-data. These have been combined into a single method to access meta-data given a string key, and a list of pre-defined keys. If you've used the \c extendedMetaData method of any class, you will need to change your code to combine the standard and extended metadata methods. \row - \o Qt Metatype registration - \o In QtMultimedia 5.0 we've tried to make sure that we register any classes + \li Qt Metatype registration + \li In QtMultimedia 5.0 we've tried to make sure that we register any classes or types that would be useful to use in cross process signals or in QVariants. If you've previously added Q_DECLARE_METATYPE macros for any QtMultimedia class you will probably need to remove them. \row - \o Video QML element - \o If you've previously used the Video QML element you may be excited + \li Video QML element + \li If you've previously used the Video QML element you may be excited to learn that it should still work as expected, but you also have the choice of using the new MediaPlayer and VideoOutput elements together for more flexible and advanced use cases. \row - \o QSoundEffect - \o The SoundEffect QML element was public and accessible in QtMultimedaKit, + \li QSoundEffect + \li The SoundEffect QML element was public and accessible in QtMultimedaKit, and now the C++ version is also available. If you managed to use the private class previously, you'll need to update your code. \row - \o Camera controls - \o A large number of the camera controls (QCameraImageProcessingControl, + \li Camera controls + \li A large number of the camera controls (QCameraImageProcessingControl, QCameraFocusControl etc) have been updated to address a number of design flaws. If you have previously been using these classes, you should check the new design. In particular, a number of discrete diff --git a/doc/src/examples/qmlvideo.qdoc b/doc/src/examples/qmlvideo.qdoc index ae9c43db2..3b186d179 100644 --- a/doc/src/examples/qmlvideo.qdoc +++ b/doc/src/examples/qmlvideo.qdoc @@ -55,13 +55,13 @@ The \l{video/qmlvideo/qml/qmlvideo/main.qml} file creates a UI which includes the following elements: \list - \o Two \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button} elements, each + \li Two \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button} elements, each of which displays a filename, and can be used to launch a \l{video/qmlvideo/qml/qmlvideo/FileBrowser.qml}{FileBrowser} - \o An exit \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button} - \o A \l{video/qmlvideo/qml/qmlvideo/SceneSelectionPanel.qml}{SceneSelectionPanel}, + \li An exit \l{video/qmlvideo/qml/qmlvideo/Button.qml}{Button} + \li A \l{video/qmlvideo/qml/qmlvideo/SceneSelectionPanel.qml}{SceneSelectionPanel}, which is a flickable list displaying the available scenes - \o 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 average over the past second. \endlist diff --git a/doc/src/examples/qmlvideofx.qdoc b/doc/src/examples/qmlvideofx.qdoc index 0eab75e28..29d4425cd 100644 --- a/doc/src/examples/qmlvideofx.qdoc +++ b/doc/src/examples/qmlvideofx.qdoc @@ -120,14 +120,14 @@ In this application, the usage of the \l{ShaderEffect} and \l{VideoOutput} elements is a bit more complicated, for the following reasons: \list - \o Each effect can be applied to either a \l{VideoOutput} or an + \li Each effect can be applied to either a \l{VideoOutput} or an \l{Image} item, so the type of the source item must be abstracted away from the effect implementation - \o For some effects (such as the edge detection and glow examples shown in + \li For some effects (such as the edge detection and glow examples shown in the screenshots above), the transformation is applied only to pixels to the left of a dividing line - this allows the effect to be easily compared with the untransformed image on the right - \o Most effects have one or more parameters which can be modified by the + \li Most effects have one or more parameters which can be modified by the user - these are controlled by sliders in the UI which are connected to uniform values passed into the GLSL code \endlist diff --git a/doc/src/multimedia.qdoc b/doc/src/multimedia.qdoc index 78426728c..50c02785e 100644 --- a/doc/src/multimedia.qdoc +++ b/doc/src/multimedia.qdoc @@ -40,15 +40,15 @@ Qt Multimedia offers APIs for doing many multimedia related tasks: \list -\o Accessing raw audio devices for input and output -\o Play low latency sound effects -\o Play media files in playlists (like compressed audio, or video files) -\o Record audio and compress it -\o Tune and listen to radio stations, and receive radio program information -\o Use a camera, including viewfinder, image capture, and movie recording -\o Play 3D positional audio -\o Decode audio media files into memory for processing -\o Accessing video frames or audio buffers as they are played or recorded +\li Accessing raw audio devices for input and output +\li Play low latency sound effects +\li Play media files in playlists (like compressed audio, or video files) +\li Record audio and compress it +\li Tune and listen to radio stations, and receive radio program information +\li Use a camera, including viewfinder, image capture, and movie recording +\li Play 3D positional audio +\li Decode audio media files into memory for processing +\li Accessing video frames or audio buffers as they are played or recorded \endlist \section2 Multimedia Components @@ -57,10 +57,10 @@ All of these tasks can be broadly broken down into four main areas. More inform (including background information and class references) are available here: \list -\o \l {Audio Overview} -\o \l {Video Overview} -\o \l {Camera Overview} -\o \l {Radio Overview} +\li \l {Audio Overview} +\li \l {Video Overview} +\li \l {Camera Overview} +\li \l {Radio Overview} \endlist \section2 Multimedia recipes @@ -68,75 +68,75 @@ For some quick recipes for specific tasks, look at the overviews above and consu \table 70% \header - \o Use case - \o Examples - \o QML Classes - \o C++ Classes + \li Use case + \li Examples + \li QML Classes + \li C++ Classes \row - \o Playing a sound effect - \o TBD - \o \l SoundEffect - \o QSoundEffect + \li Playing a sound effect + \li TBD + \li \l SoundEffect + \li QSoundEffect \row - \o Playing low latency audio - \o \l{audiooutput}, \l{spectrum} - \o - \o QAudioOutput + \li Playing low latency audio + \li \l{audiooutput}, \l{spectrum} + \li + \li QAudioOutput \row - \o Playing encoded audio (MP3, AAC etc) - \o \l{player} - \o \l Audio, \l {MediaPlayer} - \o QMediaPlayer + \li Playing encoded audio (MP3, AAC etc) + \li \l{player} + \li \l Audio, \l {MediaPlayer} + \li QMediaPlayer \row - \o Accessing raw audio input data - \o \l{spectrum}, \l audioinput - \o - \o QAudioInput + \li Accessing raw audio input data + \li \l{spectrum}, \l audioinput + \li + \li QAudioInput \row - \o Recording encoded audio data - \o \l audiorecorder - \o - \o QAudioRecorder + \li Recording encoded audio data + \li \l audiorecorder + \li + \li QAudioRecorder \row - \o Discovering raw audio devices - \o \l audiodevices - \o - \o QAudioDeviceInfo + \li Discovering raw audio devices + \li \l audiodevices + \li + \li QAudioDeviceInfo \row - \o Video Playback - \o \l {player}, \l {video/qmlvideo}{qmlvideo}, \l{video/qmlvideofx}{qmlvideofx} - \o \l MediaPlayer, \l VideoOutput, \l Video - \o QMediaPlayer, QVideoWidget, QGraphicsVideoItem + \li Video Playback + \li \l {player}, \l {video/qmlvideo}{qmlvideo}, \l{video/qmlvideofx}{qmlvideofx} + \li \l MediaPlayer, \l VideoOutput, \l Video + \li QMediaPlayer, QVideoWidget, QGraphicsVideoItem \row - \o Video Processing - \o \l {video/qmlvideofx}{qmlvideofx} - \o \l {MediaPlayer}, \l VideoOutput - \o QMediaPlayer, QAbstractVideoSurface, QVideoFrame + \li Video Processing + \li \l {video/qmlvideofx}{qmlvideofx} + \li \l {MediaPlayer}, \l VideoOutput + \li QMediaPlayer, QAbstractVideoSurface, QVideoFrame \row - \o Listening to the radio - \o \l radio, \l declarative-radio - \o \l Radio, \l RadioData - \o QRadioTuner, QRadioData + \li Listening to the radio + \li \l radio, \l declarative-radio + \li \l Radio, \l RadioData + \li QRadioTuner, QRadioData \row - \o Accessing camera viewfinder - \o \l camera, \l declarative-camera - \o \l Camera, \l VideoOutput - \o QCamera, QVideoWidget, QGraphicsVideoItem + \li Accessing camera viewfinder + \li \l camera, \l declarative-camera + \li \l Camera, \l VideoOutput + \li QCamera, QVideoWidget, QGraphicsVideoItem \row - \o Viewfinder processing - \o - \o \l Camera, \l VideoOutput - \o QCamera, QAbstractVideoSurface, QVideoFrame + \li Viewfinder processing + \li + \li \l Camera, \l VideoOutput + \li QCamera, QAbstractVideoSurface, QVideoFrame \row - \o Capturing photos - \o \l camera, \l declarative-camera - \o \l Camera - \o QCamera, QCameraImageCapture + \li Capturing photos + \li \l camera, \l declarative-camera + \li \l Camera + \li QCamera, QCameraImageCapture \row - \o Capturing movies - \o \l camera, \l declarative-camera - \o \l Camera - \o QCamera, QMediaRecorder + \li Capturing movies + \li \l camera, \l declarative-camera + \li \l Camera + \li QCamera, QMediaRecorder \endtable \section1 Multimedia Limitations diff --git a/doc/src/multimediabackend.qdoc b/doc/src/multimediabackend.qdoc index 28684dc43..bfa41a54e 100644 --- a/doc/src/multimediabackend.qdoc +++ b/doc/src/multimediabackend.qdoc @@ -55,11 +55,11 @@ Basically, the idea is that to use the Multimedia API you would use these three classes or classes derived from them as follows \list - \o \l QMediaServiceProvider is used by the top level client class to request a service. The top level class knowing what kind of service it needs. + \li \l QMediaServiceProvider is used by the top level client class to request a service. The top level class knowing what kind of service it needs. - \o \l QMediaService provides a service and when asked by the top level object, say a component, will return a QMediaControl object. + \li \l QMediaService provides a service and when asked by the top level object, say a component, will return a QMediaControl object. - \o \l QMediaControl allows the control of the service using a known interface. + \li \l QMediaControl allows the control of the service using a known interface. \endlist Consider a developer creating, for example, a media player class called MyPlayer. diff --git a/doc/src/plugins/qml-multimedia.qdoc b/doc/src/plugins/qml-multimedia.qdoc index b8d46e202..e0e721ac5 100644 --- a/doc/src/plugins/qml-multimedia.qdoc +++ b/doc/src/plugins/qml-multimedia.qdoc @@ -76,73 +76,73 @@ Much of the getting / setting of \l Audio parameters is done through properties. These include \table 70% \header - \o Property - \o Description + \li Property + \li Description \row - \o \l {Audio::source}{source} - \o The source URL of the media. + \li \l {Audio::source}{source} + \li The source URL of the media. \row - \o \l {Audio::autoLoad}{autoLoad} - \o Indicates if loading of media should begin immediately. + \li \l {Audio::autoLoad}{autoLoad} + \li Indicates if loading of media should begin immediately. \row - \o \l{Audio::playing}{playing} - \o Indicates that the media is playing. + \li \l{Audio::playing}{playing} + \li Indicates that the media is playing. \row - \o \l {Audio::paused}{paused} - \o The media is paused. + \li \l {Audio::paused}{paused} + \li The media is paused. \row - \o \l{Audio::status}{status} - \o The status of media loading. + \li \l{Audio::status}{status} + \li The status of media loading. \row - \o \l{Audio::duration}{duration} - \o Amount of time in milliseconds the media will play. + \li \l{Audio::duration}{duration} + \li Amount of time in milliseconds the media will play. \row - \o \l{Audio::position}{position} - \o Current position in the media in milliseconds of play. + \li \l{Audio::position}{position} + \li Current position in the media in milliseconds of play. \row - \o \l{Audio::volume}{volume} - \o Audio output volume: from 0.0 (silent) to 1.0 (maximum) + \li \l{Audio::volume}{volume} + \li Audio output volume: from 0.0 (silent) to 1.0 (maximum) \row - \o \l{Audio::muted}{muted} - \o Indicates audio is muted. + \li \l{Audio::muted}{muted} + \li Indicates audio is muted. \row - \o \l{Audio::bufferProgress}{bufferProgress} - \o Indicates how full the data buffer is: 0.0 (empty) to 1.0 (full). + \li \l{Audio::bufferProgress}{bufferProgress} + \li Indicates how full the data buffer is: 0.0 (empty) to 1.0 (full). \row - \o \l{Audio::seekable}{seekable} - \o Indicates whether the audio position can be changed. + \li \l{Audio::seekable}{seekable} + \li Indicates whether the audio position can be changed. \row - \o \l{Audio::playbackRate}{playbackRate} - \o The rate at which audio is played at as a multiple of the normal rate. + \li \l{Audio::playbackRate}{playbackRate} + \li The rate at which audio is played at as a multiple of the normal rate. \row - \o \l{Audio::error}{error} - \o An error code for the error state including NoError + \li \l{Audio::error}{error} + \li An error code for the error state including NoError \row - \o \l{Audio::errorString}{errorString} - \o A description of the current error condition. + \li \l{Audio::errorString}{errorString} + \li A description of the current error condition. \endtable The set of signals available allow the developer to create custom behavior when the following events occur, \table 70% \header - \o Signal - \o Description + \li Signal + \li Description \row - \o \l{Audio::onStarted}{onStarted} - \o Called when playback has been started. + \li \l{Audio::onStarted}{onStarted} + \li Called when playback has been started. \row - \o \l{Audio::onResumed}{onResumed} - \o Called when playback is resumed from the paused state. + \li \l{Audio::onResumed}{onResumed} + \li Called when playback is resumed from the paused state. \row - \o \l{Audio::onPaused}{onPaused} - \o Called when playback is paused. + \li \l{Audio::onPaused}{onPaused} + \li Called when playback is paused. \row - \o \l{Audio::onStopped}{onStopped} - \o Called when playback is stopped. + \li \l{Audio::onStopped}{onStopped} + \li Called when playback is stopped. \row - \o \l{Audio::onError}{onError} - \o Called when the specified error occurs. + \li \l{Audio::onError}{onError} + \li Called when the specified error occurs. \endtable \section2 Camera diff --git a/doc/src/radiooverview.qdoc b/doc/src/radiooverview.qdoc index 057ac5c40..467ebfb88 100644 --- a/doc/src/radiooverview.qdoc +++ b/doc/src/radiooverview.qdoc @@ -85,8 +85,8 @@ current frequency inside the band. \section2 QML Elements \list - \o \l Radio - \o \l RadioData + \li \l Radio + \li \l RadioData \endlist */ diff --git a/doc/src/videooverview.qdoc b/doc/src/videooverview.qdoc index 8a8347fc8..b8a1dd5b9 100644 --- a/doc/src/videooverview.qdoc +++ b/doc/src/videooverview.qdoc @@ -110,15 +110,15 @@ There are both C++ and QML examples available. C++ Examples: \list - \o \l video - \o \l videographicsitem - \o \l videowidget + \li \l video + \li \l videographicsitem + \li \l videowidget \endlist QML Examples: \list - \o \l qmlvideo - \o \l qmlvideofx + \li \l qmlvideo + \li \l qmlvideofx \endlist \section1 Reference Documentation @@ -130,9 +130,9 @@ QML Examples: \section2 QML Elements \list - \o \l MediaPlayer - \o \l VideoOutput - \o \l Video + \li \l MediaPlayer + \li \l VideoOutput + \li \l Video \endlist */ |