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/multimedia | |
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/multimedia')
7 files changed, 25 insertions, 21 deletions
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<size> QtMultimedia::Camera::supportedViewfinderResolutions(real minimumFrameRate = undefined, real maximumFrameRate = undefined) + \qmlmethod list<size> 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<object> QtMultimedia::Camera::supportedViewfinderFrameRateRanges(size resolution = undefined) + \qmlmethod list<object> 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<QUrl> &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 |