From d97d618a4884c2535ba787e774f0faa6bce82081 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Tue, 16 Apr 2019 10:31:40 +0200 Subject: Doc: Fix multiple documentation issues - 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 --- src/imports/audioengine/qdeclarative_sound_p.cpp | 9 ++++--- .../audioengine/qdeclarative_soundinstance_p.cpp | 14 +++++------ src/imports/multimedia/qdeclarativeaudio.cpp | 12 ++++++--- src/imports/multimedia/qdeclarativecamera.cpp | 12 ++++----- src/imports/multimedia/qdeclarativecameraflash.cpp | 4 +-- .../qdeclarativecameraimageprocessing.cpp | 4 +-- .../multimedia/qdeclarativemultimediaglobal.cpp | 2 +- src/imports/multimedia/qdeclarativeplaylist.cpp | 10 ++++---- src/imports/multimedia/qdeclarativeradio.cpp | 2 +- src/multimedia/audio/qaudiobuffer.cpp | 5 ---- src/multimedia/doc/QtMultimediaDoc | 1 - src/multimedia/doc/qtmultimedia.qdocconf | 4 +-- src/multimedia/doc/src/qtaudioengine.qdoc | 2 +- src/multimedia/doc/src/qtmultimedia5.qdoc | 29 +++++++++++++++++----- .../qdeclarativevideooutput.cpp | 4 +-- 15 files changed, 65 insertions(+), 49 deletions(-) (limited to 'src') 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. */ diff --git a/src/imports/multimedia/qdeclarativeaudio.cpp b/src/imports/multimedia/qdeclarativeaudio.cpp index 65606b3cf..692aec2d0 100644 --- a/src/imports/multimedia/qdeclarativeaudio.cpp +++ b/src/imports/multimedia/qdeclarativeaudio.cpp @@ -999,11 +999,13 @@ void QDeclarativeAudio::_q_mediaChanged(const QMediaContent &media) /*! \qmlsignal QtMultimedia::Audio::error(error, errorString) - This signal is emitted when an \l {QMediaPlayer::Error}{error} has - occurred. The errorString parameter may contain more detailed + This signal is emitted when an \a error has + occurred. The \a errorString parameter may contain more detailed information about the error. The corresponding handler is \c onError. + + \sa QMediaPlayer::Error */ /*! @@ -1531,11 +1533,13 @@ void QDeclarativeAudio::_q_mediaChanged(const QMediaContent &media) /*! \qmlsignal QtMultimedia::MediaPlayer::error(error, errorString) - This signal is emitted when an \l {QMediaPlayer::Error}{error} has - occurred. The errorString parameter may contain more detailed + This signal is emitted when an \a error has + occurred. The \a errorString parameter may contain more detailed information about the error. The corresponding handler is \c onError. + + \sa QMediaPlayer::Error */ /*! diff --git a/src/imports/multimedia/qdeclarativecamera.cpp b/src/imports/multimedia/qdeclarativecamera.cpp index c255f45d8..63896c302 100644 --- a/src/imports/multimedia/qdeclarativecamera.cpp +++ b/src/imports/multimedia/qdeclarativecamera.cpp @@ -251,7 +251,7 @@ void QDeclarativeCamera::componentComplete() preserved when changing the camera device. \sa displayName, position - \since QtMultimedia 5.4 + \since 5.4 */ QString QDeclarativeCamera::deviceId() const @@ -292,7 +292,7 @@ void QDeclarativeCamera::setDeviceId(const QString &name) preserved when changing the camera device. \sa deviceId - \since QtMultimedia 5.4 + \since 5.4 */ QDeclarativeCamera::Position QDeclarativeCamera::position() const @@ -329,7 +329,7 @@ void QDeclarativeCamera::setPosition(Position position) \readonly \sa deviceId - \since QtMultimedia 5.4 + \since 5.4 */ QString QDeclarativeCamera::displayName() const @@ -353,7 +353,7 @@ QString QDeclarativeCamera::displayName() const \readonly \sa VideoOutput::orientation - \since QtMultimedia 5.4 + \since 5.4 */ int QDeclarativeCamera::orientation() const @@ -967,7 +967,7 @@ QDeclarativeCameraViewfinder *QDeclarativeCamera::viewfinder() } /*! - \qmlmethod list QtMultimedia::Camera::supportedViewfinderResolutions(real minimumFrameRate = undefined, real maximumFrameRate = undefined) + \qmlmethod list QtMultimedia::Camera::supportedViewfinderResolutions(real minimumFrameRate, real maximumFrameRate) Returns a list of supported viewfinder resolutions. @@ -1003,7 +1003,7 @@ QJSValue QDeclarativeCamera::supportedViewfinderResolutions(qreal minimumFrameRa } /*! - \qmlmethod list QtMultimedia::Camera::supportedViewfinderFrameRateRanges(size resolution = undefined) + \qmlmethod list QtMultimedia::Camera::supportedViewfinderFrameRateRanges(size resolution) Returns a list of supported viewfinder frame rate ranges. diff --git a/src/imports/multimedia/qdeclarativecameraflash.cpp b/src/imports/multimedia/qdeclarativecameraflash.cpp index 551b88aef..5ce4a5d06 100644 --- a/src/imports/multimedia/qdeclarativecameraflash.cpp +++ b/src/imports/multimedia/qdeclarativecameraflash.cpp @@ -181,13 +181,13 @@ QVariantList QDeclarativeCameraFlash::supportedModes() const } /*! - \qmlsignal QtMultimedia::CameraFlash::flashModeChanged(int) + \qmlsignal QtMultimedia::CameraFlash::flashModeChanged() This signal is emitted when the \c flashMode property is changed. The corresponding handler is \c onFlashModeChanged. */ /*! - \qmlsignal QtMultimedia::CameraFlash::flashReady(bool) + \qmlsignal QtMultimedia::CameraFlash::flashReady() This signal is emitted when QCameraExposure indicates that the flash is ready to use. The corresponding handler is \c onFlashReadyChanged. diff --git a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp index 8e14a7945..908afea27 100644 --- a/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp +++ b/src/imports/multimedia/qdeclarativecameraimageprocessing.cpp @@ -343,14 +343,14 @@ void QDeclarativeCameraImageProcessing::setColorFilter(ColorFilter filter) } /*! - \qmlsignal QtMultimedia::Camera::whiteBalanceModeChanged(Camera::WhiteBalanceMode) + \qmlsignal QtMultimedia::Camera::whiteBalanceModeChanged() This signal is emitted when the \c whiteBalanceMode property is changed. The corresponding handler is \c onWhiteBalanceModeChanged. */ /*! - \qmlsignal QtMultimedia::Camera::manualWhiteBalanceChanged(qreal) + \qmlsignal QtMultimedia::Camera::manualWhiteBalanceChanged() This signal is emitted when the \c manualWhiteBalance property is changed. The corresponding handler is \c onManualWhiteBalanceChanged. diff --git a/src/imports/multimedia/qdeclarativemultimediaglobal.cpp b/src/imports/multimedia/qdeclarativemultimediaglobal.cpp index 999f086d5..ac7a6496f 100644 --- a/src/imports/multimedia/qdeclarativemultimediaglobal.cpp +++ b/src/imports/multimedia/qdeclarativemultimediaglobal.cpp @@ -48,7 +48,7 @@ QT_BEGIN_NAMESPACE \qmltype QtMultimedia \inqmlmodule QtMultimedia \ingroup multimedia_qml -\since QtMultimedia 5.4 +\since 5.4 \brief Provides a global object with useful functions from Qt Multimedia. The \c QtMultimedia object is a global object with utility functions and properties. diff --git a/src/imports/multimedia/qdeclarativeplaylist.cpp b/src/imports/multimedia/qdeclarativeplaylist.cpp index 549e0702d..b768f99e3 100644 --- a/src/imports/multimedia/qdeclarativeplaylist.cpp +++ b/src/imports/multimedia/qdeclarativeplaylist.cpp @@ -486,7 +486,7 @@ bool QDeclarativePlaylist::insertItems(int index, const QList &sources) Moves the item at index position \a from to index position \a to. - Returns true if the item is moved successfully. + Returns \c true if the item is moved successfully. \since 5.7 */ @@ -498,9 +498,9 @@ bool QDeclarativePlaylist::moveItem(int from, int to) /*! \qmlmethod bool QtMultimedia::Playlist::removeItem(index) - Removed the item at the given \a index from the playlist. + Removes the item at the given \a index from the playlist. - Returns true if the \a source is removed successfully. + Returns \c true if the item is removed successfully. */ bool QDeclarativePlaylist::removeItem(int index) { @@ -512,7 +512,7 @@ bool QDeclarativePlaylist::removeItem(int index) Removes items in the playlist from \a start to \a end inclusive. - Returns true if the items are removed successfully. + Returns \c true if the items are removed successfully. \since 5.7 */ @@ -526,7 +526,7 @@ bool QDeclarativePlaylist::removeItems(int start, int end) Removes all the items from the playlist. - Returns true if the operation is successful. + Returns \c true if the operation is successful. */ bool QDeclarativePlaylist::clear() { diff --git a/src/imports/multimedia/qdeclarativeradio.cpp b/src/imports/multimedia/qdeclarativeradio.cpp index ec2d943ef..f92ddd91a 100644 --- a/src/imports/multimedia/qdeclarativeradio.cpp +++ b/src/imports/multimedia/qdeclarativeradio.cpp @@ -393,7 +393,7 @@ void QDeclarativeRadio::scanUp() \qmlmethod QtMultimedia::Radio::searchAllStations(enumeration searchMode) Start searching the complete frequency range for the current band, and save all the - radio stations found. The search mode can be either of the values described in the + radio stations found. The \a searchMode can be either of the values described in the table below. \table diff --git a/src/multimedia/audio/qaudiobuffer.cpp b/src/multimedia/audio/qaudiobuffer.cpp index f3e7ae670..1e43ebd00 100644 --- a/src/multimedia/audio/qaudiobuffer.cpp +++ b/src/multimedia/audio/qaudiobuffer.cpp @@ -573,35 +573,30 @@ void *QAudioBuffer::data() /*! \typedef QAudioBuffer::S8U - \relates QAudioBuffer::StereoFrame This is a predefined specialization for an unsigned stereo 8 bit sample. Each channel is an \e {unsigned char}. */ /*! \typedef QAudioBuffer::S8S - \relates QAudioBuffer::StereoFrame This is a predefined specialization for a signed stereo 8 bit sample. Each channel is a \e {signed char}. */ /*! \typedef QAudioBuffer::S16U - \relates QAudioBuffer::StereoFrame This is a predefined specialization for an unsigned stereo 16 bit sample. Each channel is an \e {unsigned short}. */ /*! \typedef QAudioBuffer::S16S - \relates QAudioBuffer::StereoFrame This is a predefined specialization for a signed stereo 16 bit sample. Each channel is a \e {signed short}. */ /*! \typedef QAudioBuffer::S32F - \relates QAudioBuffer::StereoFrame This is a predefined specialization for an 32 bit float sample. Each channel is a \e float. diff --git a/src/multimedia/doc/QtMultimediaDoc b/src/multimedia/doc/QtMultimediaDoc index 5723c2a78..e57c3595b 100644 --- a/src/multimedia/doc/QtMultimediaDoc +++ b/src/multimedia/doc/QtMultimediaDoc @@ -1,3 +1,2 @@ #include #include -#include "../gsttools_headers/qgstutils_p.h" diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf index b547db762..256ad261e 100644 --- a/src/multimedia/doc/qtmultimedia.qdocconf +++ b/src/multimedia/doc/qtmultimedia.qdocconf @@ -56,9 +56,9 @@ imagedirs += src/images \ sourcedirs += ../.. -#excludedirs += ../../multimediawidgets +excludedirs += ../../gsttools -depends += qtcore qtdoc qtgui qtquick qtqml qtwidgets +depends += qtcore qtdoc qtgui qtquick qtqml qtwidgets qtnetwork navigation.landingpage = "Qt Multimedia" navigation.cppclassespage = "Qt Multimedia C++ Classes" diff --git a/src/multimedia/doc/src/qtaudioengine.qdoc b/src/multimedia/doc/src/qtaudioengine.qdoc index bf8be899e..c45d4e8af 100644 --- a/src/multimedia/doc/src/qtaudioengine.qdoc +++ b/src/multimedia/doc/src/qtaudioengine.qdoc @@ -55,5 +55,5 @@ SoundInstance for easier QML bindings. \li \l {AudioEngine Example}{Audio Engine} \endlist -\section1 QML types +\section1 QML Types */ diff --git a/src/multimedia/doc/src/qtmultimedia5.qdoc b/src/multimedia/doc/src/qtmultimedia5.qdoc index aec3d99d0..a2aaa1a80 100644 --- a/src/multimedia/doc/src/qtmultimedia5.qdoc +++ b/src/multimedia/doc/src/qtmultimedia5.qdoc @@ -39,11 +39,28 @@ The QML types for \l{Qt Multimedia} support the basic use cases such as: \li and access camera settings. \endlist -The QML types can be imported into your application using the following import -statement in your .qml file: -\code -import QtMultimedia 5.8 -\endcode +\section1 QML Types -\section1 QML types +Qt Multimedia QML types can be imported into your application using the +following import statement in your .qml file: + +\qml \QtMinorVersion +import QtMultimedia 5.\1 +\endqml + +\generatelist qmltypesbymodule QtMultimedia + +\section2 Qt Audio Engine + +\l {QtAudioEngine}{Qt Audio Engine} provides types for 3D positional audio +playback and content management. These types can be imported into your +application using the following import statement in your .qml file: + +\qml \QtMinorVersion +import QtAudioEngine 1.\1 +\endqml + +\generatelist qmltypesbymodule QtAudioEngine + +\noautolist */ diff --git a/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp b/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp index b6d3afaa4..4ef605e28 100644 --- a/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp +++ b/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp @@ -511,7 +511,7 @@ void QDeclarativeVideoOutput::setOrientation(int orientation) By default \c autoOrientation is disabled. \sa orientation - \since QtMultimedia 5.2 + \since 5.2 */ bool QDeclarativeVideoOutput::autoOrientation() const { @@ -880,7 +880,7 @@ void QDeclarativeVideoOutput::_q_invalidateSceneGraph() /*! \qmlproperty enumeration QtMultimedia::VideoOutput::flushMode - \since QtMultimedia 5.13 + \since 5.13 Set this property to define what \c VideoOutput should show when playback is finished or stopped. -- cgit v1.2.3