diff options
author | Topi Reinio <topi.reinio@qt.io> | 2019-11-12 11:42:26 +0100 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-13 12:03:36 +0100 |
commit | 2eabff2d4a8fb4afc9ab3eb06bfddf8ffc0ba2b2 (patch) | |
tree | 2a7799d0b413a06489e847f30cdfd81834960d27 | |
parent | c8496db8f90bcdc6b8ee02ab76ed5425c447f339 (diff) | |
download | qtmultimedia-2eabff2d4a8fb4afc9ab3eb06bfddf8ffc0ba2b2.tar.gz |
Doc: Fix documentation warnings
Mark member functions of \internal classes also as \internal, as
otherwise QDoc fails to match function documentation with the
declaration in the header.
Comment out one instance of \instantiates referring to an internal
class.
Fixes: QTBUG-79834
Change-Id: I056c060537ee60beca128166ae3903ae3289a413
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
-rw-r--r-- | src/multimedia/qmediaserviceprovider.cpp | 11 | ||||
-rw-r--r-- | src/qtmultimediaquicktools/qdeclarativevideooutput.cpp | 2 |
2 files changed, 12 insertions, 1 deletions
diff --git a/src/multimedia/qmediaserviceprovider.cpp b/src/multimedia/qmediaserviceprovider.cpp index 5731cf5be..d8ffe42ae 100644 --- a/src/multimedia/qmediaserviceprovider.cpp +++ b/src/multimedia/qmediaserviceprovider.cpp @@ -682,6 +682,7 @@ Q_GLOBAL_STATIC(QPluginServiceProvider, pluginProvider); */ /*! + \internal \fn QMediaServiceProvider::requestService(const QByteArray &type, const QMediaServiceProviderHint &hint) Requests an instance of a \a type service which best matches the given \a @@ -695,12 +696,14 @@ Q_GLOBAL_STATIC(QPluginServiceProvider, pluginProvider); */ /*! + \internal \fn QMediaServiceProvider::releaseService(QMediaService *service) Releases a media \a service requested with requestService(). */ /*! + \internal \fn QMediaServiceProvider::supportedFeatures(const QMediaService *service) const Returns the features supported by a given \a service. @@ -713,6 +716,7 @@ QMediaServiceProviderHint::Features QMediaServiceProvider::supportedFeatures(con } /*! + \internal Returns how confident a media service provider is that is can provide a \a serviceType service that is able to play media of a specific \a mimeType that is encoded using the listed \a codecs while adhering to constraints @@ -732,6 +736,7 @@ QMultimedia::SupportEstimate QMediaServiceProvider::hasSupport(const QByteArray } /*! + \internal \fn QStringList QMediaServiceProvider::supportedMimeTypes(const QByteArray &serviceType, int flags) const Returns a list of MIME types supported by the service provider for the @@ -749,6 +754,7 @@ QStringList QMediaServiceProvider::supportedMimeTypes(const QByteArray &serviceT } /*! + \internal \since 5.3 Returns the default device for a \a service type. @@ -760,6 +766,7 @@ QByteArray QMediaServiceProvider::defaultDevice(const QByteArray &serviceType) c } /*! + \internal Returns the list of devices related to \a service type. */ QList<QByteArray> QMediaServiceProvider::devices(const QByteArray &service) const @@ -769,6 +776,7 @@ QList<QByteArray> QMediaServiceProvider::devices(const QByteArray &service) cons } /*! + \internal Returns the description of \a device related to \a serviceType, suitable for use by an application for display. */ @@ -780,6 +788,7 @@ QString QMediaServiceProvider::deviceDescription(const QByteArray &serviceType, } /*! + \internal \since 5.3 Returns the physical position of a camera \a device on the system hardware. @@ -791,6 +800,7 @@ QCamera::Position QMediaServiceProvider::cameraPosition(const QByteArray &device } /*! + \internal \since 5.3 Returns the physical orientation of the camera \a device. The value is the angle by which the @@ -818,6 +828,7 @@ void QMediaServiceProvider::setDefaultServiceProvider(QMediaServiceProvider *pro /*! + \internal Returns a default provider of media services. */ QMediaServiceProvider *QMediaServiceProvider::defaultServiceProvider() diff --git a/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp b/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp index 74c83246f..32166502d 100644 --- a/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp +++ b/src/qtmultimediaquicktools/qdeclarativevideooutput.cpp @@ -57,7 +57,7 @@ Q_LOGGING_CATEGORY(qLcVideo, "qt.multimedia.video") /*! \qmltype VideoOutput - \instantiates QDeclarativeVideoOutput + //! \instantiates QDeclarativeVideoOutput \brief Render video or camera viewfinder. \ingroup multimedia_qml |