Doc: Part 1 Fix Qt Multimedia documentation issues

TODO:
    * src/multimedia/audio/qaudiobuffer.cpp:333: (qdoc) warning: Cannot find 'QAudioBuffer::StereoFrame'
    * multimediaquick/camerafocus.qdoc content refers to now-removed classes
    * multimediawidgets module doc needs CMake build instructions/snippet
    * Lots of undocumented parameters, enum values, other minor things

Pick-to: 6.2
Change-Id: I4861aa0edf2904e5e43783f5167c5d2ba575b91b
Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
Reviewed-by: Lars Knoll <lars.knoll@qt.io>

1 files changed, 29 insertions, 12 deletions

diff --git a/src/multimedia/qmediaformat.cpp b/src/multimedia/qmediaformat.cpp
index fd049679d..4cd66143a 100644
--- a/src/multimedia/qmediaformat.cpp
+++ b/src/multimedia/qmediaformat.cpp
@@ -127,19 +127,33 @@ QT_DEFINE_QESDP_SPECIALIZATION_DTOR(QMediaFormatPrivate);
 /*! \enum QMediaFormat::FileFormat
 
     Describes the container format used in a multimedia file or stream.
+
+    //! TODO document each \value
+
+    \omitvalue LastFileFormat
 */
 
 /*! \enum QMediaFormat::AudioCodec
 
     Describes the audio coded used in multimedia file or stream.
+
+    //! TODO document each \value
+
+    \omitvalue LastAudioCodec
 */
 
-/*! \enum QMediaFormat::AudioCodec
+/*! \enum QMediaFormat::VideoCodec
 
     Describes the video coded used in multimedia file or stream.
+
+    //! TODO document each \value
+
+    \omitvalue LastVideoCodec
 */
 
 /*! \class QMediaFormat
+    \inmodule QtMultimedia
+    \since 6.2
 
     Describes an encoding format for a multimedia file or stream.
 
@@ -182,18 +196,26 @@ QMediaFormat &QMediaFormat::operator=(const QMediaFormat &other) noexcept = defa
     Moves \a other into this QMediaFormat objects.
 */
 
-/*! \fn void QMediaFormat::setMediaContainer(QMediaFormat::FileFormat container)
+// Properties
+/*! \property QMediaFormat::fileFormat
 
-    Sets the container to \a container.
+    \brief The file (container) format of the media.
 
-    \sa mediaContainer(), QMediaFormat::FileFormat
+    \sa QMediaFormat::FileFormat
 */
 
-/*! \fn QMediaFormat::FileFormat QMediaFormat::mediaContainer() const
+/*! \property QMediaFormat::audioCodec
 
-    Returns the container used in this format.
+    \brief The audio codec of the media.
 
-    \sa setMediaContainer(), QMediaFormat::FileFormat
+    \sa QMediaFormat::AudioCodec
+*/
+
+/*! \property QMediaFormat::videoCodec
+
+    \brief The video codec of the media.
+
+    \sa QMediaFormat::VideoCodec
 */
 
 /*! \fn void QMediaFormat::setVideoCodec(VideoCodec codec)
@@ -224,11 +246,6 @@ QMediaFormat &QMediaFormat::operator=(const QMediaFormat &other) noexcept = defa
     \sa setAudioCodec(), QMediaFormat::AudioCodec
 */
 
-/*! \fn bool QMediaFormat::isValid() const
-
-    Returns true if the format is valid.
-*/
-
 /*!
     Returns true if Qt Multimedia can encode or decode this format,
     depending on \a mode.