diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-04-16 10:31:40 +0200 |
---|---|---|
committer | Topi Reiniƶ <topi.reinio@qt.io> | 2019-04-16 09:32:56 +0000 |
commit | d97d618a4884c2535ba787e774f0faa6bce82081 (patch) | |
tree | 81a493c10a27f8a5f52cace24c9cf7330b8e3faa /src/imports/audioengine | |
parent | d55edfc3cf6b65949835586b4b216cfd672c8380 (diff) |
Doc: Fix multiple documentation issuesv5.13.0-beta3
- GstTools has some (internal) documentation, but was causing a number of
warnings with QDoc's clang parser - exclude it from the documentation
build.
- Remove direct links from example documentation to individual example
files; they no longer work.
- Fix navigation for QML types; The main QML types pages did not list
types for QtAudioEngiine.
- Use \QtMinorVersion macro to make the documented import versions
follow the minor Qt version.
- Fix \since usage to be consistent throughout.
- Fix linking issues for QML properties/methods
- Minor language fixes
Change-Id: I735cd13fa6dedd6bf06d6b6ef50ce2e0d69a545b
Reviewed-by: VaL Doroshchuk <valentyn.doroshchuk@qt.io>
Diffstat (limited to 'src/imports/audioengine')
-rw-r--r-- | src/imports/audioengine/qdeclarative_sound_p.cpp | 9 | ||||
-rw-r--r-- | src/imports/audioengine/qdeclarative_soundinstance_p.cpp | 14 |
2 files changed, 12 insertions, 11 deletions
diff --git a/src/imports/audioengine/qdeclarative_sound_p.cpp b/src/imports/audioengine/qdeclarative_sound_p.cpp index a11490cea..347198f61 100644 --- a/src/imports/audioengine/qdeclarative_sound_p.cpp +++ b/src/imports/audioengine/qdeclarative_sound_p.cpp @@ -61,7 +61,8 @@ QDeclarativeSoundCone::QDeclarativeSoundCone(QObject *parent) \qmlproperty real Sound::cone.innerAngle This property holds the innerAngle for Sound definition. - The range is [0, 360] degree. There is no directional attenuation within innerAngle. + The range is [0, 360] degree. There is no directional attenuation + within innerAngle. */ qreal QDeclarativeSoundCone::innerAngle() const { @@ -88,8 +89,8 @@ void QDeclarativeSoundCone::setInnerAngle(qreal innerAngle) \qmlproperty real Sound::cone.outerAngle This property holds the outerAngle for Sound definition. - The range is [0, 360] degree. All audio output from this sound will be attenuated by \l outerGain - outside outerAngle. + The range is [0, 360] degree. All audio output from this sound will be + attenuated by \l {cone.outerGain}{outerGain} outside outerAngle. */ qreal QDeclarativeSoundCone::outerAngle() const { @@ -117,7 +118,7 @@ void QDeclarativeSoundCone::setOuterAngle(qreal outerAngle) This property holds attenuation value for directional attenuation of this sound. The range is [0, 1]. All audio output from this sound will be attenuated by outerGain - outside \l outerAngle. + outside \l {cone.outerAngle}{outerAngle}. */ qreal QDeclarativeSoundCone::outerGain() const { diff --git a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp index 7f8c33233..ad7480031 100644 --- a/src/imports/audioengine/qdeclarative_soundinstance_p.cpp +++ b/src/imports/audioengine/qdeclarative_soundinstance_p.cpp @@ -519,7 +519,7 @@ void QDeclarativeSoundInstance::handleStateChanged() /*! \qmlsignal QtAudioEngine::SoundInstance::stateChanged(state) - This signal is emitted when \l state is changed + This signal is emitted when \a state is changed. The corresponding handler is \c onStateChanged. */ @@ -527,7 +527,7 @@ void QDeclarativeSoundInstance::handleStateChanged() /*! \qmlsignal QtAudioEngine::SoundInstance::positionChanged() - This signal is emitted when \l position is changed + This signal is emitted when \l position is changed. The corresponding handler is \c onPositionChanged. */ @@ -535,7 +535,7 @@ void QDeclarativeSoundInstance::handleStateChanged() /*! \qmlsignal QtAudioEngine::SoundInstance::directionChanged() - This signal is emitted when \l direction is changed + This signal is emitted when \l direction is changed. The corresponding handler is \c onDirectionChanged. */ @@ -543,7 +543,7 @@ void QDeclarativeSoundInstance::handleStateChanged() /*! \qmlsignal QtAudioEngine::SoundInstance::velocityChanged() - This signal is emitted when \l velocity is changed + This signal is emitted when \l velocity is changed. The corresponding handler is \c onVelocityChanged. */ @@ -551,7 +551,7 @@ void QDeclarativeSoundInstance::handleStateChanged() /*! \qmlsignal QtAudioEngine::SoundInstance::gainChanged() - This signal is emitted when \l gain is changed + This signal is emitted when \l gain is changed. The corresponding handler is \c onGainChanged. */ @@ -559,7 +559,7 @@ void QDeclarativeSoundInstance::handleStateChanged() /*! \qmlsignal QtAudioEngine::SoundInstance::pitchChanged() - This signal is emitted when \l pitch is changed + This signal is emitted when \l pitch is changed. The corresponding handler is \c onPitchChanged. */ @@ -567,7 +567,7 @@ void QDeclarativeSoundInstance::handleStateChanged() /*! \qmlsignal QtAudioEngine::SoundInstance::soundChanged() - This signal is emitted when \l sound is changed + This signal is emitted when \l sound is changed. The corresponding handler is \c onSoundChanged. */ |