summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2023-12-13 12:24:22 +0000
committerTopi Reiniƶ <topi.reinio@qt.io>2023-12-14 03:01:48 +0000
commite11d73132d481d0033b2b39124d61fd2163f8959 (patch)
tree6fdb0e212bcac187a504b22839f8b6dea8507dba
parent2f99eaefc24ea1a0b8341a9e442a81a19f25b9a1 (diff)
Doc: Fix example file quoting and missing namespace documentation
Fixes the following documentation warnings: declarative-camera.qdoc:54: (qdoc) warning: Command '\printto' failed at end of file declarative-camera.qdoc:152: (qdoc) warning: Command '\printuntil' failed at end of file qvideo.cpp:8: (qdoc) warning: RotationAngle is documented, but namespace QVideo is not documented in any module. Mark the documentation project free of warnings. Pick-to: 6.7 6.6 Change-Id: I45153fa9f6ba29a9d636229ef0a0465916f0291f Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r--examples/multimedia/declarative-camera/doc/src/declarative-camera.qdoc20
-rw-r--r--src/multimedia/doc/qtmultimedia.qdocconf5
-rw-r--r--src/multimedia/video/qvideo.cpp7
3 files changed, 19 insertions, 13 deletions
diff --git a/examples/multimedia/declarative-camera/doc/src/declarative-camera.qdoc b/examples/multimedia/declarative-camera/doc/src/declarative-camera.qdoc
index 633592aad..4228d415e 100644
--- a/examples/multimedia/declarative-camera/doc/src/declarative-camera.qdoc
+++ b/examples/multimedia/declarative-camera/doc/src/declarative-camera.qdoc
@@ -31,12 +31,13 @@ Item, \c controlLayout like so:
\quotefromfile declarative-camera/declarative-camera.qml
\skipto Item {
-\printto PhotoCaptureControls {
+\printuntil /^ }/
The \c stillControls and \c videoControls objects both bind to the \c state
and \c buttonsWidth properties of this Item, as shown in \c stillControls:
-\printto VideoCaptureControls {
+\skipto PhotoCaptureControls
+\printuntil /^ }/
To support debugging, a message about layout state change is logged.
@@ -48,7 +49,9 @@ You can see the \c state property is initially set as \c PhotoCapture.
Then the \c states themselves are defined like so:
-\printto CaptureSession {
+\quotefromfile declarative-camera/declarative-camera.qml
+\skipto states: [
+\printuntil /^ ]/
\section1 Controls for capturing
@@ -141,16 +144,15 @@ Here we check if the functions are supported:
\quotefromfile declarative-camera/FlashControl.qml
\skipto property Camera cameraDevice
-\printto Column {
+\printline Camera
+\printline FlashOn
+\printline TorchOn
Here we implement the \c flashModeControl switch, which also directly controls
the Camera device.
-\printuntil cameraDevice.flashMode = Camera.FlashOff;
+\skipto Switch {
+\printuntil /^ }/
Torch control is implemented in a similar way.
-
-
-
-
*/
diff --git a/src/multimedia/doc/qtmultimedia.qdocconf b/src/multimedia/doc/qtmultimedia.qdocconf
index 836014f95..02f5e0503 100644
--- a/src/multimedia/doc/qtmultimedia.qdocconf
+++ b/src/multimedia/doc/qtmultimedia.qdocconf
@@ -80,7 +80,4 @@ manifestmeta.highlighted.names = \
manifestmeta.highlighted.names += "QtMultimedia/QML Camera Application"
# Fail the documentation build if there are more warnings than the limit
-
-warninglimit += 2
-# examples/multimedia/declarative-camera/doc/src/declarative-camera.qdoc:4: (qdoc) warning: Missing image: qml-declarative-portrait.png
-# examples/multimedia/declarative-camera/doc/src/declarative-camera.qdoc:4: (qdoc) warning: Missing image: FlashControls.png
+warninglimit += 0
diff --git a/src/multimedia/video/qvideo.cpp b/src/multimedia/video/qvideo.cpp
index 13f524334..9d5af1d8f 100644
--- a/src/multimedia/video/qvideo.cpp
+++ b/src/multimedia/video/qvideo.cpp
@@ -6,6 +6,13 @@
QT_BEGIN_NAMESPACE
/*!
+ \namespace QVideo
+ \since 6.7
+ \inmodule QtMultimedia
+ \brief Enumerations for camera and video functionality.
+*/
+
+/*!
\enum QVideo::RotationAngle
\since 6.7