diff options
author | Topi Reinio <topi.reinio@qt.io> | 2021-09-09 14:56:54 +0200 |
---|---|---|
committer | Topi Reinio <topi.reinio@qt.io> | 2021-09-09 21:55:16 +0200 |
commit | e22ddea9d62d84a4b28b2395d4f259dd1d4b1094 (patch) | |
tree | 3940e1dedf80f6946d0cd2b77f0319c4208027e9 /examples | |
parent | 9bcb332f599fc7f2dccfac688d8d019533ccab76 (diff) |
Doc: Fix various documentation issues
* Fix linking issues
* Document all QMediaFormat::AudioCodec enum values
* Fix example \quotefromfile paths
* Document QMediaFormat::ResolveFlags
* Drop links to removed classes/functions
Pick-to: 6.2 6.2.0
Fixes: QTBUG-96340
Change-Id: Iae82295e9cd396b392af2e577b21158ad1509fd3
Reviewed-by: Lars Knoll <lars.knoll@qt.io>
Diffstat (limited to 'examples')
-rw-r--r-- | examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc | 8 | ||||
-rw-r--r-- | examples/multimediawidgets/camera/doc/src/camera.qdoc | 11 |
2 files changed, 7 insertions, 12 deletions
diff --git a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc index b8e14508e..c37c37c1c 100644 --- a/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc +++ b/examples/multimedia/audiorecorder/doc/src/audiorecorder.qdoc @@ -76,11 +76,9 @@ will have the text "Resume". Pressing the buttons will also result in a toggle based on the state. If - recording is stopped, then pressing the record button will setup the - \l{QAudioEncoderSettings} based on the values of the selection lists, - will set the encoding settings and container on the \c audioRecorder - object, and start recording using the - \l{QMediaRecorder::record()}{record()} method. + recording is stopped, then pressing the record button will set the encoding + settings and container on the \c audioRecorder object, and start recording + using the \l{QMediaRecorder::record()}{record()} method. \code QMediaFormat format; diff --git a/examples/multimediawidgets/camera/doc/src/camera.qdoc b/examples/multimediawidgets/camera/doc/src/camera.qdoc index b8b9730d2..495abb328 100644 --- a/examples/multimediawidgets/camera/doc/src/camera.qdoc +++ b/examples/multimediawidgets/camera/doc/src/camera.qdoc @@ -71,13 +71,10 @@ object is called. Now that the camera is ready for user commands it waits for a suitable event. Such an event can be a key press of either the \l {Qt::Key_CameraFocus} or \l {Qt::Key_Camera} buttons on the application window. Camera focus will -simply display the preview and lock the camera settings. Key_Camera will -either call \e{takeImage()} if the \l {QCamera::captureMode()}{captureMode()} -is QCamera::CaptureStillImage, or if the capture mode is for video then one -of two actions will occur. If the recording state shows that we are currently -recording then the \e{stop()} function is called resulting in a call to -\l {QCamera::stop()}, whereas if we are not recording then a video recording -is started with a call to \l {QMediaRecorder::record()}. +simply display the preview and lock the camera settings. \c Key_Camera will +either call \e{takeImage()} if doing an image capture, or call +\c record() or \c stop() (if already recording) on the QMediaRecorder instance +when recording video. \image camera-example.png |