Updated a lot of minor fixes to the docs and removed warnings from qdoc

Change-Id: Ib7fd75fb93c038f9e8fa9d71b6ad01fb27b97622
Reviewed-by: Michael Goddard <michael.goddard@nokia.com>

1 files changed, 25 insertions, 19 deletions

diff --git a/doc/src/videooverview.qdoc b/doc/src/videooverview.qdoc
index b8a1dd5b9..eecfd1ed8 100644
--- a/doc/src/videooverview.qdoc
+++ b/doc/src/videooverview.qdoc
@@ -57,7 +57,7 @@ And an example with QGraphicsVideoItem:
 You can use the \l VideoOutput QML element to render content that is
 provided by either a \l MediaPlayer element or a \l Camera element.
 The VideoOutput element is a visual element that can be transformed
-or acted upon by shaders (as the \l {qmlvideofx} example shows), while
+or acted upon by shaders (as the \l {QML Video Shader Effects Example} shows), while
 all media decoding and playback control is handled by the MediaPlayer
 element.
 
@@ -76,7 +76,16 @@ The \l QVideoFrame class encapsulates a video frame and allows the
 contents to be mapped into system memory for manipulation or
 processing, while deriving a class from \l QAbstractVideoSurface
 allows you to receive these frames from \l QMediaPlayer and
-\l QCamera.  Several of the built in Qt classes offer this functionality
+\l QCamera.
+
+\snippet doc/src/snippets/multimedia-snippets/video.cpp Derived Surface
+
+and with an instance of this surface, \c myVideoSurface, you can set
+the surface as the \l {QMediaPlayer::setVideoOutput()}{video output} for QMediaPlayer.
+
+\snippet doc/src/snippets/multimedia-snippets/video.cpp Setting surface in player
+
+Several of the built in Qt classes offer this functionality
 as well, so if you decode video in your application, you can present
 it to classes that offer a \l QVideoRendererControl class, and in QML
 you can set a custom object for the source of the \l VideoOutput element
@@ -85,6 +94,12 @@ set it's internal video surface to) or a readable \c mediaObject property
 with a QMediaObject derived class that implements the \l QVideoRendererControl
 interface.
 
+The following snippet shows a class that has a writable \c videoSurface property
+and receives frames through a public slot \c onNewVideoContentReceived(). These
+frames are then presented on the surface set in \c setVideoSurface().
+
+\snippet doc/src/snippets/multimedia-snippets/video.cpp Video producer
+
 \section2 Recording video
 You can use the \l QMediaRecorder class in conjunction with other
 classes to record video to disk.  Primarily this is used with
@@ -108,31 +123,22 @@ Here's an example of installing a video probe while recording the camera:
 
 There are both C++ and QML examples available.
 
-C++ Examples:
-\list
-    \li \l video
-    \li \l videographicsitem
-    \li \l videowidget
-\endlist
+\section2 C++ Examples
+
+\annotatedlist video_examples
+
+\section2 QML Examples
 
-QML Examples:
-\list
-    \li \l qmlvideo
-    \li \l qmlvideofx
-\endlist
+\annotatedlist video_examples_qml
 
 \section1 Reference Documentation
 
-\section2 Video Classes
+\section2 C++ Classes
 
 \annotatedlist multimedia_video
 
 \section2 QML Elements
 
-\list
-    \li \l MediaPlayer
-    \li \l VideoOutput
-    \li \l Video
-\endlist
+\annotatedlist multimedia_video_qml
 
 */