From: Sze Howe Koh Date: Fri, 14 Mar 2014 23:11:32 +0000 (+0800) Subject: Doc: Qt Audio Engine: Restore lost docs X-Git-Tag: upstream/5.2.95+rc1~3^2~25 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=d204391cc1cf75601a8fb4a5037060508af40585;p=platform%2Fupstream%2Fqtmultimedia.git Doc: Qt Audio Engine: Restore lost docs When QDoc stopped accepting the version number of QML modules, some parts of QML documentation disappeared silently. Change-Id: I528a2d77587e5803ed971dfe8849d0b37d9c555a Reviewed-by: Jerome Pasion --- diff --git a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp index 4456f17..3e8cece 100644 --- a/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp +++ b/src/imports/audioengine/qdeclarative_attenuationmodel_p.cpp @@ -140,7 +140,7 @@ void QDeclarativeAttenuationModel::setName(const QString& name) */ /*! - \qmlproperty string QtAudioEngine1::AttenuationModelLinear::name + \qmlproperty string QtAudioEngine::AttenuationModelLinear::name This property holds the name of AttenuationModelLinear, must be unique among all attenuation models and only defined once. @@ -162,7 +162,7 @@ void QDeclarativeAttenuationModelLinear::componentComplete() } /*! - \qmlproperty real QtAudioEngine1::AttenuationModelLinear::start + \qmlproperty real QtAudioEngine::AttenuationModelLinear::start This property holds the start distance. There will be no attenuation if the distance from sound to listener is within this range. @@ -187,7 +187,7 @@ void QDeclarativeAttenuationModelLinear::setStartDistance(qreal startDist) } /*! - \qmlproperty real QtAudioEngine1::AttenuationModelLinear::end + \qmlproperty real QtAudioEngine::AttenuationModelLinear::end This property holds the end distance. There will be no sound hearable if the distance from sound to listener is larger than this. @@ -280,14 +280,14 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene */ /*! - \qmlproperty string QtAudioEngine1::AttenuationModelInverse::name + \qmlproperty string QtAudioEngine::AttenuationModelInverse::name This property holds the name of AttenuationModelInverse, must be unique among all attenuation models and only defined once. */ /*! - \qmlproperty real QtAudioEngine1::AttenuationModelInverse::start + \qmlproperty real QtAudioEngine::AttenuationModelInverse::start This property holds the start distance. There will be no attenuation if the distance from sound to listener is within this range. @@ -295,7 +295,7 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene */ /*! - \qmlproperty real QtAudioEngine1::AttenuationModelInverse::end + \qmlproperty real QtAudioEngine::AttenuationModelInverse::end This property holds the end distance. There will be no further attenuation if the distance from sound to listener is larger than this. @@ -303,7 +303,7 @@ qreal QDeclarativeAttenuationModelLinear::calculateGain(const QVector3D &listene */ /*! - \qmlproperty real QtAudioEngine1::AttenuationModelInverse::rolloff + \qmlproperty real QtAudioEngine::AttenuationModelInverse::rolloff This property holds the rolloff factor. The bigger the value is, the faster the sound attenuates. The default value is 1. diff --git a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp index a115c0f..c3e5e4e 100644 --- a/src/imports/audioengine/qdeclarative_audiocategory_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiocategory_p.cpp @@ -58,8 +58,8 @@ QT_USE_NAMESPACE This type is part of the \b{QtAudioEngine 1.0} module. - An instance of AudioCategory can be accessed through QtAudioEngine1::AudioEngine::categories with its - unique name and must be defined inside AudioEngine. + An instance of AudioCategory can be accessed through \l {QtAudioEngine::AudioEngine::categories} + {AudioEngine.categories} with its unique name and must be defined inside AudioEngine. \qml import QtQuick 2.0 @@ -138,7 +138,7 @@ void QDeclarativeAudioCategory::componentComplete() } /*! - \qmlproperty real QtAudioEngine1::AudioCategory::volume + \qmlproperty real QtAudioEngine::AudioCategory::volume This property holds the volume of the category and will modulate all audio output from the instances which belong to this category. @@ -160,7 +160,7 @@ void QDeclarativeAudioCategory::setVolume(qreal volume) } /*! - \qmlproperty string QtAudioEngine1::AudioCategory::name + \qmlproperty string QtAudioEngine::AudioCategory::name This property holds the name of AudioCategory. The name must be unique among all categories and only defined once. The name cannot be changed after the instance has been initialized. @@ -180,7 +180,7 @@ QString QDeclarativeAudioCategory::name() const } /*! - \qmlmethod QtAudioEngine1::AudioCategory::stop() + \qmlmethod QtAudioEngine::AudioCategory::stop() Stops all active sound instances which belong to this category. */ @@ -190,7 +190,7 @@ void QDeclarativeAudioCategory::stop() } /*! - \qmlmethod QtAudioEngine1::AudioCategory::pause() + \qmlmethod QtAudioEngine::AudioCategory::pause() Pauses all active sound instances which belong to this category. */ @@ -200,7 +200,7 @@ void QDeclarativeAudioCategory::pause() } /*! - \qmlmethod QtAudioEngine1::AudioCategory::pause() + \qmlmethod QtAudioEngine::AudioCategory::pause() Resumes all active sound instances from paused state which belong to this category. */ diff --git a/src/imports/audioengine/qdeclarative_audioengine_p.cpp b/src/imports/audioengine/qdeclarative_audioengine_p.cpp index 7f0a8e7..e0c1ea0 100644 --- a/src/imports/audioengine/qdeclarative_audioengine_p.cpp +++ b/src/imports/audioengine/qdeclarative_audioengine_p.cpp @@ -195,7 +195,7 @@ void QDeclarativeAudioEngine::releaseManagedDeclarativeSoundInstance(QDeclarativ } /*! - \qmlproperty int QtAudioEngine1::AudioEngine::liveInstances + \qmlproperty int QtAudioEngine::AudioEngine::liveInstances This property indicates how many live sound instances there are at the moment. */ @@ -408,7 +408,7 @@ QQmlListProperty QDeclarativeAudioEngine::bank() } /*! - \qmlproperty map QtAudioEngine1::AudioEngine::categories + \qmlproperty map QtAudioEngine::AudioEngine::categories Container of all AudioCategory instances. */ @@ -418,7 +418,7 @@ QObject* QDeclarativeAudioEngine::categories() } /*! - \qmlproperty map QtAudioEngine1::AudioEngine::samples + \qmlproperty map QtAudioEngine::AudioEngine::samples Container of all AudioSample instances. */ @@ -428,7 +428,7 @@ QObject* QDeclarativeAudioEngine::samples() } /*! - \qmlproperty map QtAudioEngine1::AudioEngine::sounds + \qmlproperty map QtAudioEngine::AudioEngine::sounds Container of all Sound instances. */ @@ -438,7 +438,7 @@ QObject* QDeclarativeAudioEngine::sounds() } /*! - \qmlproperty QtAudioEngine1::AudioListener QtAudioEngine1::AudioEngine::listener + \qmlproperty QtAudioEngine::AudioListener QtAudioEngine::AudioEngine::listener This property holds the listener object. You can change various properties to affect the 3D positioning of sounds. @@ -451,7 +451,7 @@ QDeclarativeAudioListener* QDeclarativeAudioEngine::listener() const } /*! - \qmlproperty real QtAudioEngine1::AudioEngine::dopplerFactor + \qmlproperty real QtAudioEngine::AudioEngine::dopplerFactor This property holds a simple scaling for the effect of doppler shift. */ @@ -466,7 +466,7 @@ void QDeclarativeAudioEngine::setDopplerFactor(qreal dopplerFactor) } /*! - \qmlproperty real QtAudioEngine1::AudioEngine::speedOfSound + \qmlproperty real QtAudioEngine::AudioEngine::speedOfSound This property holds the reference value of the sound speed (in meters per second) which will be used in doppler shift calculation. The doppler shift calculation is @@ -485,7 +485,7 @@ void QDeclarativeAudioEngine::setSpeedOfSound(qreal speedOfSound) } /*! - \qmlproperty bool QtAudioEngine1::AudioEngine::loading + \qmlproperty bool QtAudioEngine::AudioEngine::loading This property indicates if the audio engine is loading any audio sample at the moment. This may be useful if you specified the preloaded property in AudioSample and would like to show a loading screen @@ -505,7 +505,7 @@ void QDeclarativeAudioEngine::handleLoadingChanged() } /*! - \qmlsignal QtAudioEngine1::AudioEngine::finishedLoading() + \qmlsignal QtAudioEngine::AudioEngine::finishedLoading() This signal is emitted when \l loading has completed. @@ -513,7 +513,7 @@ void QDeclarativeAudioEngine::handleLoadingChanged() */ /*! - \qmlsignal QtAudioEngine1::AudioEngine::ready() + \qmlsignal QtAudioEngine::AudioEngine::ready() This signal is emitted when the AudioEngine is ready to use. @@ -521,7 +521,7 @@ void QDeclarativeAudioEngine::handleLoadingChanged() */ /*! - \qmlsignal QtAudioEngine1::AudioEngine::liveInstanceCountChanged() + \qmlsignal QtAudioEngine::AudioEngine::liveInstanceCountChanged() This signal is emitted when the number of live instances managed by the AudioEngine is changed. @@ -530,7 +530,7 @@ void QDeclarativeAudioEngine::handleLoadingChanged() */ /*! - \qmlsignal QtAudioEngine1::AudioEngine::isLoadingChanged() + \qmlsignal QtAudioEngine::AudioEngine::isLoadingChanged() This signal is emitted when the \l loading property changes. diff --git a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp index 9e0be0d..c148111 100644 --- a/src/imports/audioengine/qdeclarative_audiolistener_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiolistener_p.cpp @@ -155,7 +155,7 @@ QDeclarativeAudioListener::~QDeclarativeAudioListener() } /*! - \qmlproperty QtAudioEngine1::AudioEngine QtAudioEngine1::AudioListener::engine + \qmlproperty QtAudioEngine::AudioEngine QtAudioEngine::AudioListener::engine This property holds the reference to AudioEngine, must be set only once. */ @@ -171,7 +171,7 @@ void QDeclarativeAudioListener::setEngine(QDeclarativeAudioEngine *engine) } /*! - \qmlproperty vector3d QtAudioEngine1::AudioListener::position + \qmlproperty vector3d QtAudioEngine::AudioListener::position This property holds the 3d position of the listener. */ @@ -190,7 +190,7 @@ void QDeclarativeAudioListener::setPosition(const QVector3D &position) } /*! - \qmlproperty vector3d QtAudioEngine1::AudioListener::direction + \qmlproperty vector3d QtAudioEngine::AudioListener::direction This property holds the normalized 3d direction vector of the listener. */ @@ -209,7 +209,7 @@ void QDeclarativeAudioListener::setDirection(const QVector3D &direction) } /*! - \qmlproperty vector3d QtAudioEngine1::AudioListener::velocity + \qmlproperty vector3d QtAudioEngine::AudioListener::velocity This property holds the 3d velocity vector of the listener. */ @@ -228,7 +228,7 @@ void QDeclarativeAudioListener::setVelocity(const QVector3D &velocity) } /*! - \qmlproperty vector3d QtAudioEngine1::AudioListener::up + \qmlproperty vector3d QtAudioEngine::AudioListener::up This property holds the normalized 3d up vector of the listener. */ @@ -247,7 +247,7 @@ void QDeclarativeAudioListener::setUp(const QVector3D &up) } /*! - \qmlproperty real QtAudioEngine1::AudioListener::gain + \qmlproperty real QtAudioEngine::AudioListener::gain This property will modulate all audio output from audio engine instances. */ diff --git a/src/imports/audioengine/qdeclarative_audiosample_p.cpp b/src/imports/audioengine/qdeclarative_audiosample_p.cpp index 0a6acb2..7d1ca09 100644 --- a/src/imports/audioengine/qdeclarative_audiosample_p.cpp +++ b/src/imports/audioengine/qdeclarative_audiosample_p.cpp @@ -61,7 +61,7 @@ QT_USE_NAMESPACE \c AudioSample is part of the \b{QtAudioEngine 1.0} module. - It can be accessed through QtAudioEngine1::AudioEngine::samples with its unique + It can be accessed through QtAudioEngine::AudioEngine::samples with its unique name and must be defined inside AudioEngine. \qml @@ -134,7 +134,7 @@ bool QDeclarativeAudioSample::isStreaming() const } /*! - \qmlproperty bool QtAudioEngine1::AudioSample::preloaded + \qmlproperty bool QtAudioEngine::AudioSample::preloaded This property indicates whether this sample needs to be preloaded or not. If true, the audio engine will start loading the sample file immediately when the app started, @@ -147,7 +147,7 @@ bool QDeclarativeAudioSample::isPreloaded() const } /*! - \qmlproperty bool QtAudioEngine1::AudioSample::loaded + \qmlproperty bool QtAudioEngine::AudioSample::loaded This property indicates whether this sample has been loaded into memory or not. */ @@ -159,7 +159,7 @@ bool QDeclarativeAudioSample::isLoaded() const } /*! - \qmlmethod void QtAudioEngine1::AudioSample::load() + \qmlmethod void QtAudioEngine::AudioSample::load() Starts loading the sample into memory if not loaded. */ @@ -193,7 +193,7 @@ void QDeclarativeAudioSample::setStreaming(bool streaming) } /*! - \qmlproperty string QtAudioEngine1::AudioSample::name + \qmlproperty string QtAudioEngine::AudioSample::name This property holds the name of AudioSample, must be unique among all samples and only defined once. @@ -237,7 +237,7 @@ QSoundBuffer* QDeclarativeAudioSample::soundBuffer() const } /*! - \qmlsignal QtAudioEngine1::AudioSample::onLoadedChanged() + \qmlsignal QtAudioEngine::AudioSample::onLoadedChanged() This handler is called when \l loaded is changed */ diff --git a/src/imports/audioengine/qdeclarative_playvariation_p.cpp b/src/imports/audioengine/qdeclarative_playvariation_p.cpp index 204ffb2..b9a0a3a 100644 --- a/src/imports/audioengine/qdeclarative_playvariation_p.cpp +++ b/src/imports/audioengine/qdeclarative_playvariation_p.cpp @@ -143,7 +143,7 @@ void QDeclarativePlayVariation::componentComplete() } /*! - \qmlproperty string QtAudioEngine1::PlayVariation::sample + \qmlproperty string QtAudioEngine::PlayVariation::sample This property specifies which \l AudioSample this variation will use. */ @@ -162,7 +162,7 @@ void QDeclarativePlayVariation::setSample(const QString& sample) } /*! - \qmlproperty bool QtAudioEngine1::PlayVariation::looping + \qmlproperty bool QtAudioEngine::PlayVariation::looping This property indicates whether the playback will be looped or not. */ @@ -181,7 +181,7 @@ void QDeclarativePlayVariation::setLooping(bool looping) } /*! - \qmlproperty real QtAudioEngine1::PlayVariation::maxGain + \qmlproperty real QtAudioEngine::PlayVariation::maxGain This property specifies the maximum gain adjustment that can be applied in any playback. */ @@ -204,7 +204,7 @@ void QDeclarativePlayVariation::setMaxGain(qreal maxGain) } /*! - \qmlproperty real QtAudioEngine1::PlayVariation::minGain + \qmlproperty real QtAudioEngine::PlayVariation::minGain This property specifies the minimum gain adjustment that can be applied in any playback. */ @@ -227,7 +227,7 @@ void QDeclarativePlayVariation::setMinGain(qreal minGain) } /*! - \qmlproperty real QtAudioEngine1::PlayVariation::maxPitch + \qmlproperty real QtAudioEngine::PlayVariation::maxPitch This property specifies the maximum pitch adjustment that can be applied in any playback. */ @@ -250,7 +250,7 @@ void QDeclarativePlayVariation::setMaxPitch(qreal maxPitch) } /*! - \qmlproperty real QtAudioEngine1::PlayVariation::minPitch + \qmlproperty real QtAudioEngine::PlayVariation::minPitch This property specifies the minimum pitch adjustment that can be applied in any playback. */ diff --git a/src/imports/audioengine/qdeclarative_sound_p.cpp b/src/imports/audioengine/qdeclarative_sound_p.cpp index 5b22d43..e6c690c 100644 --- a/src/imports/audioengine/qdeclarative_sound_p.cpp +++ b/src/imports/audioengine/qdeclarative_sound_p.cpp @@ -150,7 +150,7 @@ void QDeclarativeSoundCone::componentComplete() This type is part of the \b{QtAudioEngine 1.0} module. - Sound can be accessed through QtAudioEngine1::AudioEngine::sounds with its unique name + Sound can be accessed through QtAudioEngine::AudioEngine::sounds with its unique name and must be defined inside AudioEngine. \qml @@ -228,7 +228,7 @@ void QDeclarativeSound::componentComplete() } /*! - \qmlproperty enumeration QtAudioEngine1::Sound::playType + \qmlproperty enumeration QtAudioEngine::Sound::playType This property holds the playType. It can be one of: @@ -254,7 +254,7 @@ void QDeclarativeSound::setPlayType(PlayType playType) } /*! - \qmlproperty string QtAudioEngine1::Sound::category + \qmlproperty string QtAudioEngine::Sound::category This property specifies which AudioCategory this sound belongs to. */ @@ -273,7 +273,7 @@ void QDeclarativeSound::setCategory(const QString& category) } /*! - \qmlproperty string QtAudioEngine1::Sound::name + \qmlproperty string QtAudioEngine::Sound::name This property holds the name of Sound, must be unique among all sounds and only defined once. @@ -293,7 +293,7 @@ void QDeclarativeSound::setName(const QString& name) } /*! - \qmlproperty string QtAudioEngine1::Sound::attenuationModel + \qmlproperty string QtAudioEngine::Sound::attenuationModel This property specifies which attenuation model this sound will apply. */ @@ -382,7 +382,7 @@ void QDeclarativeSound::appendFunction(QQmlListProperty