summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Bennett <nicholas.bennett@qt.io>2021-12-15 11:28:45 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-12-16 11:24:58 +0000
commitf8a8c152f2e7339c64fd07666aae8f62e9119cc9 (patch)
treebff42d7e170de698708523cee6ac521d4469e01d
parentdebc5d179b84d00297d1fa5f01ce0eab13353e8a (diff)
downloadqtmultimedia-f8a8c152f2e7339c64fd07666aae8f62e9119cc9.tar.gz
Docs: Fix qdoc warnings for QVideoFrame
Added \a for parameters. Changed "tells" to "returns" in function description. Task-number: QTBUG-97469 Change-Id: I9606e2d9dee533e6fcb964f5fc847ce1ab15013f Reviewed-by: Lars Knoll <lars.knoll@qt.io> (cherry picked from commit 0ae2b6e9dce1b6322f74f027c847b9216f906bae) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/multimedia/video/qvideoframe.cpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/multimedia/video/qvideoframe.cpp b/src/multimedia/video/qvideoframe.cpp
index 1620bb78a..ea48afc7e 100644
--- a/src/multimedia/video/qvideoframe.cpp
+++ b/src/multimedia/video/qvideoframe.cpp
@@ -702,7 +702,7 @@ void QVideoFrame::setEndTime(qint64 time)
}
/*!
- Sets the counterclockwise rotation angle for the frame
+ Sets the counterclockwise rotation \a angle for the frame.
*/
void QVideoFrame::setRotationAngle(QVideoFrame::RotationAngle angle)
{
@@ -711,8 +711,8 @@ void QVideoFrame::setRotationAngle(QVideoFrame::RotationAngle angle)
}
/*!
- Tells the angle the frame should be rotated counterclockwise before
- displaying
+ Returns the angle the frame should be rotated counterclockwise before
+ displaying.
*/
QVideoFrame::RotationAngle QVideoFrame::rotationAngle() const
{
@@ -720,7 +720,7 @@ QVideoFrame::RotationAngle QVideoFrame::rotationAngle() const
}
/*!
- Sets the mirrored flag for the frame
+ Sets the \a mirrored flag for the frame.
*/
void QVideoFrame::setMirrored(bool mirrored)
{
@@ -729,7 +729,7 @@ void QVideoFrame::setMirrored(bool mirrored)
}
/*!
- Tells whether the frame should be mirrored before displaying
+ Returns whether the frame should be mirrored before displaying.
*/
bool QVideoFrame::mirrored() const
{