From 3793b0653f4127e8f84808419b05115a66c3bc03 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:27:06 +0200 Subject: [PATCH] Doc: Various fixes to Qt Audio Engine documentation -fixed \since to "\since 5.0" (Qt version 5.0) -made a \qmlmodule page so the list of related classes are automatically listed -made changes in the Qt Multimedia documentation to link to the Qt Audio Engine documentation Change-Id: Ibdd3da02871648988a73172934e684840c4ce0ae Reviewed-by: Yoann Lopes --- .../qdeclarative_attenuationmodel_p.cpp | 8 +-- .../audioengine/qdeclarative_audiocategory_p.cpp | 4 +- .../audioengine/qdeclarative_audioengine_p.cpp | 4 +- .../audioengine/qdeclarative_audiolistener_p.cpp | 4 +- .../audioengine/qdeclarative_audiosample_p.cpp | 4 +- .../audioengine/qdeclarative_playvariation_p.cpp | 4 +- src/imports/audioengine/qdeclarative_sound_p.cpp | 4 +- .../audioengine/qdeclarative_soundinstance_p.cpp | 4 +- ...audioengineoverview.qdoc => qtaudioengine.qdoc} | 60 ++++++++-------------- src/multimedia/doc/src/qtmultimedia-index.qdoc | 23 ++++++--- 10 files changed, 55 insertions(+), 64 deletions(-) rename src/multimedia/doc/src/{audioengineoverview.qdoc => qtaudioengine.qdoc} (53%) diff --git a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp index 4787389..4456f17 100644 --- a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp +++ b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp @@ -92,9 +92,9 @@ void QDeclarativeAttenuationModel::setName(const QString& name) /*! \qmltype AttenuationModelLinear \instantiates QDeclarativeAttenuationModelLinear - \since 1.0 + \since 5.0 \brief Defines a linear attenuation curve for a \l Sound. - \inqmlmodule QtAudioEngine 1.0 + \inqmlmodule QtAudioEngine \ingroup multimedia_audioengine \inherits Item \preliminary @@ -225,9 +225,9 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene \qmltype AttenuationModelInverse \instantiates QDeclarativeAttenuationModelInverse - \since 1.0 + \since 5.0 \brief Defines a non-linear attenuation curve for a \l Sound. - \inqmlmodule QtAudioEngine 1.0 + \inqmlmodule QtAudioEngine \ingroup multimedia_audioengine \inherits Item \preliminary diff --git a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp index a980f76..a115c0f 100644 --- a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp @@ -49,9 +49,9 @@ QT_USE_NAMESPACE /*! \qmltype AudioCategory \instantiates QDeclarativeAudioCategory - \since 1.0 + \since 5.0 \brief Control all active sound instances by group. - \inqmlmodule QtAudioEngine 1.0 + \inqmlmodule QtAudioEngine \ingroup multimedia_audioengine \inherits Item \preliminary diff --git a/src/imports/audioengine/qdeclarative_audioengine_p.cpp b/src/imports/audioengine/qdeclarative_audioengine_p.cpp index 4e4169e..7f0a8e7 100644 --- a/src/imports/audioengine/qdeclarative_audioengine_p.cpp +++ b/src/imports/audioengine/qdeclarative_audioengine_p.cpp @@ -58,9 +58,9 @@ QT_BEGIN_NAMESPACE /*! \qmltype AudioEngine \instantiates QDeclarativeAudioEngine - \since 1.0 + \since 5.0 \brief Organize all your 3d audio content in one place. - \inqmlmodule QtAudioEngine 1.0 + \inqmlmodule QtAudioEngine \ingroup multimedia_audioengine \inherits Item \preliminary diff --git a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp index e5ee9fa..9e0be0d 100644 --- a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp @@ -50,9 +50,9 @@ QT_USE_NAMESPACE /*! \qmltype AudioListener \instantiates QDeclarativeAudioListener - \since 1.0 + \since 5.0 \brief Control global listener parameters. - \inqmlmodule QtAudioEngine 1.0 + \inqmlmodule QtAudioEngine \ingroup multimedia_audioengine \inherits Item \preliminary diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp index 1736157..0a6acb2 100644 --- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp @@ -52,9 +52,9 @@ QT_USE_NAMESPACE /*! \qmltype AudioSample \instantiates QDeclarativeAudioSample - \since 1.0 + \since 5.0 \brief Load audio samples, mostly .wav. - \inqmlmodule QtAudioEngine 1.0 + \inqmlmodule QtAudioEngine \ingroup multimedia_audioengine \inherits Item \preliminary diff --git a/src/imports/audioengine/qdeclarative_playvariation_p.cpp b/src/imports/audioengine/qdeclarative_playvariation_p.cpp index 27d4c65..204ffb2 100644 --- a/src/imports/audioengine/qdeclarative_playvariation_p.cpp +++ b/src/imports/audioengine/qdeclarative_playvariation_p.cpp @@ -51,12 +51,12 @@ QT_USE_NAMESPACE /*! \qmltype PlayVariation \instantiates QDeclarativePlayVariation - \since 1.0 + \since 5.0 \brief Define a playback variation for \l {Sound} {sounds}. So each time the playback of the same sound can be a slightly different even with the same AudioSample. - \inqmlmodule QtAudioEngine 1.0 + \inqmlmodule QtAudioEngine \ingroup multimedia_audioengine \inherits Item \preliminary diff --git a/src/imports/audioengine/qdeclarative_sound_p.cpp b/src/imports/audioengine/qdeclarative_sound_p.cpp index f715af0..5b22d43 100644 --- a/src/imports/audioengine/qdeclarative_sound_p.cpp +++ b/src/imports/audioengine/qdeclarative_sound_p.cpp @@ -140,10 +140,10 @@ void QDeclarativeSoundCone::componentComplete() /*! \qmltype Sound \instantiates QDeclarativeSound - \since 1.0 + \since 5.0 \brief Define a variety of samples and parameters to be used for SoundInstance. - \inqmlmodule QtAudioEngine 1.0 + \inqmlmodule QtAudioEngine \ingroup multimedia_audioengine \inherits Item \preliminary diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp index b1c5f3c..f2576a7 100644 --- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp +++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp @@ -53,9 +53,9 @@ QT_USE_NAMESPACE /*! \qmltype SoundInstance \instantiates QDeclarativeSoundInstance - \since 1.0 + \since 5.0 \brief Play 3d audio content. - \inqmlmodule QtAudioEngine 1.0 + \inqmlmodule QtAudioEngine \ingroup multimedia_audioengine \inherits Item \preliminary diff --git a/src/multimedia/doc/src/audioengineoverview.qdoc b/src/multimedia/doc/src/qtaudioengine.qdoc similarity index 53% rename from src/multimedia/doc/src/audioengineoverview.qdoc rename to src/multimedia/doc/src/qtaudioengine.qdoc index c3bf793..b6fec8b 100644 --- a/src/multimedia/doc/src/audioengineoverview.qdoc +++ b/src/multimedia/doc/src/qtaudioengine.qdoc @@ -26,54 +26,34 @@ ****************************************************************************/ /*! -\page audioengineoverview.html -\title Positional Audio -\brief 3D positional audio playback and content management +\qmlmodule QtAudioEngine 1.0 +\title Qt Audio Engine QML Types +\ingroup qmlmodules +\brief Provides QML types for 3D positional audio playback and content management. -\section1 QtAudioEngine Features +Qt Audio Engine is part of the \l{Qt Multimedia} module. Qt Audio +Engine provides types for 3D positional audio playback and content management. -Qt Multimedia includes the \c QtAudioEngine QML module for -providing 3D positional audio playback and content management. - -QtAudioEngine enables developers to organize wave files into discrete \l Sound with different -\l {PlayVariation}{play variations}, group sound controls by \l {AudioCategory} categories and -define \l {AttenuationModelLinear}{attenuation models} and various 3d audio settings all in one -place. Playback of \l {SoundInstance}{sound instances} can be conveniently activated by in-app -events and managed by QtAudioEngine or controlled by explicitly defining \l SoundInstance -for easier QML bindings. - -To access these QML types import the -\b{QtAudioEngine 1.0} module. - -\qml -import QtQuick 2.0 +The QML types can be imported into your application using the following import +statement in your .qml file: +\code import QtAudioEngine 1.0 +\endcode -AudioEngine { -//... -} -\endqml +\section1 Qt Audio Engine Features + +Qt Audio Engine enables developers to organize wave files into discrete \l Sound +with different \l {PlayVariation}{play variations}, group sound controls by \l +{AudioCategory} categories and define \l {AttenuationModelLinear}{attenuation +models} and various 3D audio settings all in one place. Playback of \l +{SoundInstance}{sound instances} can be conveniently activated by in-app events +and managed by QtAudioEngine or controlled by explicitly defining \l +SoundInstance for easier QML bindings. \section1 Examples \list \li \l {AudioEngine Example}{Audio Engine} \endlist -\section1 Reference Documentation - -\section2 QML Types - -\list - \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 - +\section1 QML types */ diff --git a/src/multimedia/doc/src/qtmultimedia-index.qdoc b/src/multimedia/doc/src/qtmultimedia-index.qdoc index ed5b93d..140594d 100644 --- a/src/multimedia/doc/src/qtmultimedia-index.qdoc +++ b/src/multimedia/doc/src/qtmultimedia-index.qdoc @@ -33,7 +33,9 @@ Qt Multimedia is an essential module that provides a rich set of QML types and C++ classes to handle multimedia content. It also provides necessary - APIs to access the camera and radio functionality. + APIs to access the camera and radio functionality. The included + \l{Qt Audio Engine QML Types}{Qt Audio Engine} provides types for + 3D positional audio playback and management. The \l{Qt Multimedia Widgets} module provides widget based multimedia classes. @@ -122,7 +124,6 @@ \list \li \l Multimedia - overview of multimedia support in Qt \li \l{Audio Overview} - \li \l{Positional Audio} \li \l{Video Overview} \li \l{Camera Overview} \li \l{Radio Overview} @@ -135,10 +136,20 @@ \endlist \section2 Reference - \list - \li \l{Qt Multimedia QML Types}{QML Types} - \li \l{Qt Multimedia C++ Classes}{C++ Classes} - \endlist + \list + \li Qt Multimedia + \list + \li \l{Qt Multimedia QML Types}{QML Types} + \li \l{Qt Multimedia C++ Classes}{C++ Classes} + \endlist + \endlist + + \list + \li Qt Audio Engine + \list + \li \l{Qt Audio Engine QML Types}{QML Types} + \endlist + \endlist \section2 Examples \list -- 2.7.4