summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>2022-09-28 11:15:30 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2022-10-07 10:13:12 +0000
commitd76ece0841cb01a2557a0dab5897faa349740424 (patch)
treee3c17140e4950fc9e705218cc92149c209baec1e
parent2970eeafcaced56296816f41f8334308da8e8447 (diff)
downloadqtmultimedia-d76ece0841cb01a2557a0dab5897faa349740424.tar.gz
Doc: Fix qdoc warnings for undocumented members in QVideo*
Change-Id: Ieb825a93f62da4919986643ba6b7a2d8f1d05815 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io> (cherry picked from commit d8c9f246e2a9dcaa68eb1bf49d732bd1b0a77e7c) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/multimedia/video/qvideoframe.cpp6
-rw-r--r--src/multimedia/video/qvideoframeformat.cpp10
-rw-r--r--src/multimedia/video/qvideosink.cpp9
3 files changed, 24 insertions, 1 deletions
diff --git a/src/multimedia/video/qvideoframe.cpp b/src/multimedia/video/qvideoframe.cpp
index 34ec1527d..e0f45cecd 100644
--- a/src/multimedia/video/qvideoframe.cpp
+++ b/src/multimedia/video/qvideoframe.cpp
@@ -149,6 +149,12 @@ QVideoFrame::QVideoFrame(const QVideoFrame &other) = default;
*/
/*!
+ \fn void QVideoFrame::swap(QVideoFrame &other) noexcept
+
+ Swaps the current video frame with \a other.
+*/
+
+/*!
\fn QVideoFrame &QVideoFrame::operator=(QVideoFrame &&other)
Moves \a other into this QVideoFrame.
diff --git a/src/multimedia/video/qvideoframeformat.cpp b/src/multimedia/video/qvideoframeformat.cpp
index bc8fbe2e1..22ccc1ac5 100644
--- a/src/multimedia/video/qvideoframeformat.cpp
+++ b/src/multimedia/video/qvideoframeformat.cpp
@@ -372,6 +372,12 @@ QVideoFrameFormat::QVideoFrameFormat(const QVideoFrameFormat &other) = default;
*/
/*!
+ \fn void QVideoFrameFormat::swap(QVideoFrameFormat &other) noexcept
+
+ Swaps the current video frame format with the \a other.
+*/
+
+/*!
Assigns the values of \a other to this object.
*/
QVideoFrameFormat &QVideoFrameFormat::operator =(const QVideoFrameFormat &other) = default;
@@ -699,7 +705,9 @@ float QVideoFrameFormat::maxLuminance() const
}
return d->maxLuminance;
}
-
+/*!
+ Sets the maximum luminance to the given value, \a lum.
+*/
void QVideoFrameFormat::setMaxLuminance(float lum)
{
detach();
diff --git a/src/multimedia/video/qvideosink.cpp b/src/multimedia/video/qvideosink.cpp
index 3597255d5..1c91f455d 100644
--- a/src/multimedia/video/qvideosink.cpp
+++ b/src/multimedia/video/qvideosink.cpp
@@ -135,6 +135,11 @@ QVideoFrame QVideoSink::videoFrame() const
}
/*!
+ \fn void QVideoSink::videoFrameChanged(const QVideoFrame &frame) const
+
+ Signals when the video \a frame changes.
+*/
+/*!
Sets the current video \a frame.
*/
void QVideoSink::setVideoFrame(const QVideoFrame &frame)
@@ -144,6 +149,8 @@ void QVideoSink::setVideoFrame(const QVideoFrame &frame)
}
/*!
+ \property QVideoSink::subtitleText
+
Returns the current subtitle text.
*/
QString QVideoSink::subtitleText() const
@@ -161,6 +168,8 @@ void QVideoSink::setSubtitleText(const QString &subtitle)
}
/*!
+ \property QVideoSink::videoSize
+
Returns the size of the video currently being played back. If no video is
being played, this method returns an invalid size.
*/