Add documention for Modbus slave and master examples

Task-number: QTBUG-51053
Change-Id: I62e6a88e93eb0a35465d540d8eeaeb812ea7a108
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>

4 files changed, 88 insertions, 0 deletions

diff --git a/examples/serialbus/modbus/master/doc/images/modbusmaster.png b/examples/serialbus/modbus/master/doc/images/modbusmaster.png
new file mode 100644
index 0000000..faf66c7
--- /dev/null
+++ b/examples/serialbus/modbus/master/doc/images/modbusmaster.png
diff --git a/examples/serialbus/modbus/master/doc/src/modbusmaster.qdoc b/examples/serialbus/modbus/master/doc/src/modbusmaster.qdoc
new file mode 100644
index 0000000..4492bbf
--- /dev/null
+++ b/examples/serialbus/modbus/master/doc/src/modbusmaster.qdoc
@@ -0,0 +1,43 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*! \example modbus/master
+    \title Modbus Master example
+
+    \brief The example implements a Modbus master application.
+
+    The example acts as Modbus master sending Modbus request via serial line
+    and TCP respectively. The shown dialog allows the definition of standard requests and
+    displays incoming responses.
+
+    \image ../images/modbusmaster.png
+
+    \include examples-run.qdocinc
+
+    The example must be used in conjunction with the \l {Modbus Slave example} or another
+    Mobus device which is either connected via TCP or Serial Bus.
+*/
diff --git a/examples/serialbus/modbus/slave/doc/images/modbusserver.png b/examples/serialbus/modbus/slave/doc/images/modbusserver.png
new file mode 100644
index 0000000..795457a
--- /dev/null
+++ b/examples/serialbus/modbus/slave/doc/images/modbusserver.png
diff --git a/examples/serialbus/modbus/slave/doc/src/modbusslave.qdoc b/examples/serialbus/modbus/slave/doc/src/modbusslave.qdoc
new file mode 100644
index 0000000..1a7ae55
--- /dev/null
+++ b/examples/serialbus/modbus/slave/doc/src/modbusslave.qdoc
@@ -0,0 +1,45 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see http://www.qt.io/terms-conditions. For further
+** information use the contact form at http://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*! \example modbus/slave
+    \title Modbus Slave example
+
+    \brief The example implements a Modbus slave application.
+
+    The example acts as Modbus slave. It receives standard Modbus requests,
+    adjusts its internal states based on the request and responds with the
+    appropriate reply. As such a slave is the equivalent of a Modbus server.
+
+    \image ../images/modbusserver.png
+
+    \include examples-run.qdocinc
+
+    This example must be used in conjunction with the \l {Modbus Master example}.
+    This example should be started and put into the listen state before
+    the Modbus master example is started. Subsequent interactions between the two examples
+    use the Modbus protocol.
+*/