Doc: Edited example documentation.

-added information about how to run the example by including a file
 from qtbase/doc/global
-edited summary sections
-added \brief.
-removed image captions. Our Qt 5 CSS files don't handle them.

Task-number: QTBUG-33597
Change-Id: If3293aa9d98b662f20af2af7030b0ab0fb1e8401
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>

1 files changed, 7 insertions, 5 deletions

diff --git a/examples/serialport/doc/blockingmaster.qdoc b/examples/serialport/doc/blockingmaster.qdoc
index 32176a1..0aa0c3f 100644
--- a/examples/serialport/doc/blockingmaster.qdoc
+++ b/examples/serialport/doc/blockingmaster.qdoc
@@ -2,6 +2,7 @@
 **
 ** Copyright (C) 2011 - 2012 Denis Shienkov <denis.shienkov@gmail.com>
 ** Copyright (C) 2012 - 2013 Laszlo Papp <lpapp@kde.org>
+** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
 ** Contact: http://www.qt-project.org/legal
 **
 ** This file is part of the documentation of the Qt Toolkit.
@@ -30,13 +31,12 @@
     \example blockingmaster
     \title Blocking Master Example
     \ingroup qtserialport-examples
-    \brief Explains how to use the synchronous API of QSerialPort.
+    \brief Shows how to use the synchronous API of QSerialPort in a worker thread.
 
-    The blocking master example shows how to create an application for a
-    serial interface using the synchronous API of QSerialPort in a worker
-    thread.
+    \e{Blocking Master} shows how to create an application for a serial
+    interface using the synchronous API of QSerialPort in a worker thread.
 
-    \image blockingmaster-example.png Screenshot of the blocking master example
+    \image blockingmaster-example.png
 
     QSerialPort supports two programming alternatives:
 
@@ -162,4 +162,6 @@
     \snippet blockingmaster/masterthread.cpp 13
 
     \sa {Terminal Example}, {Blocking Slave Example}
+
+    \include examples-run.qdocinc
 */