From 508ca281961a9dd59f21218adfa2305b6a4c8ac1 Mon Sep 17 00:00:00 2001 From: Michael Goddard Date: Mon, 16 Jan 2012 16:27:32 +1000 Subject: Fix up a few doc issues * lingering references to Mobility * missing group tags on some classes meant they went missing * put classes into functional groups as well (e.g. audio, camera) * added some of the qdoc files to OTHER_FILES so they show up in Creator There are still a lot of warnings since it seems like qdoc is not processing the controls directory. Change-Id: I036f8826ae63f8273b3e649cb32c091d964ce830 Reviewed-by: Jonas Rabbe --- src/multimedia/audio/qaudio.cpp | 1 + src/multimedia/audio/qaudiodeviceinfo.cpp | 1 + src/multimedia/audio/qaudioformat.cpp | 3 ++- src/multimedia/audio/qaudioinput.cpp | 3 ++- src/multimedia/audio/qaudiooutput.cpp | 3 ++- src/multimedia/audio/qaudiosystem.cpp | 1 + src/multimedia/audio/qaudiosystemplugin.cpp | 1 + src/multimedia/audio/qsound.cpp | 2 +- src/multimedia/audio/qsoundeffect.cpp | 12 ++++++++++++ 9 files changed, 23 insertions(+), 4 deletions(-) (limited to 'src/multimedia/audio') diff --git a/src/multimedia/audio/qaudio.cpp b/src/multimedia/audio/qaudio.cpp index 3064c9461..0609b2527 100644 --- a/src/multimedia/audio/qaudio.cpp +++ b/src/multimedia/audio/qaudio.cpp @@ -67,6 +67,7 @@ public: \brief The QAudio namespace contains enums used by the audio classes. \inmodule QtMultimedia \ingroup multimedia + \ingroup multimedia_audio */ /* diff --git a/src/multimedia/audio/qaudiodeviceinfo.cpp b/src/multimedia/audio/qaudiodeviceinfo.cpp index 88730c30c..857da3cf6 100644 --- a/src/multimedia/audio/qaudiodeviceinfo.cpp +++ b/src/multimedia/audio/qaudiodeviceinfo.cpp @@ -107,6 +107,7 @@ public: \brief The QAudioDeviceInfo class provides an interface to query audio devices and their functionality. \inmodule QtMultimedia \ingroup multimedia + \ingroup multimedia_audio QAudioDeviceInfo lets you query for audio devices--such as sound cards and USB headsets--that are currently available on the system. diff --git a/src/multimedia/audio/qaudioformat.cpp b/src/multimedia/audio/qaudioformat.cpp index 01a72010f..2d44327c1 100644 --- a/src/multimedia/audio/qaudioformat.cpp +++ b/src/multimedia/audio/qaudioformat.cpp @@ -107,7 +107,8 @@ public: \brief The QAudioFormat class stores audio stream parameter information. \inmodule QtMultimedia - \ingroup multimedia + \ingroup multimedia + \ingroup multimedia_audio An audio format specifies how data in an audio stream is arranged, i.e, how the stream is to be interpreted. The encoding itself is diff --git a/src/multimedia/audio/qaudioinput.cpp b/src/multimedia/audio/qaudioinput.cpp index 4cab93861..26f122ee7 100644 --- a/src/multimedia/audio/qaudioinput.cpp +++ b/src/multimedia/audio/qaudioinput.cpp @@ -54,7 +54,8 @@ QT_BEGIN_NAMESPACE \brief The QAudioInput class provides an interface for receiving audio data from an audio input device. \inmodule QtMultimedia - \ingroup multimedia + \ingroup multimedia + \ingroup multimedia_audio You can construct an audio input with the system's \l{QAudioDeviceInfo::defaultInputDevice()}{default audio input diff --git a/src/multimedia/audio/qaudiooutput.cpp b/src/multimedia/audio/qaudiooutput.cpp index faf160c81..1e9619ea4 100644 --- a/src/multimedia/audio/qaudiooutput.cpp +++ b/src/multimedia/audio/qaudiooutput.cpp @@ -55,7 +55,8 @@ QT_BEGIN_NAMESPACE \brief The QAudioOutput class provides an interface for sending audio data to an audio output device. \inmodule QtMultimedia - \ingroup multimedia + \ingroup multimedia + \ingroup multimedia_audio You can construct an audio output with the system's \l{QAudioDeviceInfo::defaultOutputDevice()}{default audio output diff --git a/src/multimedia/audio/qaudiosystem.cpp b/src/multimedia/audio/qaudiosystem.cpp index adfd94737..0ffe57956 100644 --- a/src/multimedia/audio/qaudiosystem.cpp +++ b/src/multimedia/audio/qaudiosystem.cpp @@ -48,6 +48,7 @@ QT_BEGIN_NAMESPACE \brief The QAbstractAudioDeviceInfo class is a base class for audio backends. \ingroup multimedia + \ingroup multimedia_audio \inmodule QtMultimedia \internal diff --git a/src/multimedia/audio/qaudiosystemplugin.cpp b/src/multimedia/audio/qaudiosystemplugin.cpp index f2532f375..62e44d2c8 100644 --- a/src/multimedia/audio/qaudiosystemplugin.cpp +++ b/src/multimedia/audio/qaudiosystemplugin.cpp @@ -49,6 +49,7 @@ QT_BEGIN_NAMESPACE \brief The QAudioSystemPlugin class provides an abstract base for audio plugins. \ingroup multimedia + \ingroup multimedia_audio \inmodule QtMultimedia \internal diff --git a/src/multimedia/audio/qsound.cpp b/src/multimedia/audio/qsound.cpp index 7a51bd92a..7a737cdc9 100644 --- a/src/multimedia/audio/qsound.cpp +++ b/src/multimedia/audio/qsound.cpp @@ -49,7 +49,7 @@ \brief The QSound class provides a way to play .wav sound files. \ingroup multimedia - + \ingroup multimedia_audio Qt provides the most commonly required audio operation in GUI applications: asynchronously playing a sound file. This is most diff --git a/src/multimedia/audio/qsoundeffect.cpp b/src/multimedia/audio/qsoundeffect.cpp index 3b3d2339b..f7d33084e 100644 --- a/src/multimedia/audio/qsoundeffect.cpp +++ b/src/multimedia/audio/qsoundeffect.cpp @@ -54,6 +54,7 @@ QT_BEGIN_NAMESPACE \brief The SoundEffect element provides a way to play sound effects in QML. \inmodule QtMultimedia + \ingroup multimedia_qml This element is part of the \bold{QtMultimedia 5.0} module. @@ -62,6 +63,17 @@ QT_BEGIN_NAMESPACE \snippet doc/src/snippets/multimedia-snippets/soundeffect.qml complete snippet */ +/*! + \class QSoundEffect + \brief The QSoundEffect provides a way to play low latency sound effects. + + \ingroup multimedia + \ingroup multimedia_audio + +*/ + + + /*! \qmlproperty url SoundEffect::source -- cgit v1.2.3