Doc: Fix QDoc warnings and errors

Change-Id: I2a53d2726b17ec356b39f94022fe0bdccbc6b25f
Reviewed-by: Rainer Keller <Rainer.Keller@qt.io>

3 files changed, 39 insertions, 36 deletions

diff --git a/examples/opcua/opcuaviewer/doc/opcuaviewer.qdoc b/examples/opcua/opcuaviewer/doc/opcuaviewer.qdoc
index 7baf78b..493f325 100644
--- a/examples/opcua/opcuaviewer/doc/opcuaviewer.qdoc
+++ b/examples/opcua/opcuaviewer/doc/opcuaviewer.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2019 The Qt Company Ltd.
 ** Contact: http://www.qt.io/licensing/
 **
 ** This file is part of the documentation of the QtOpcUa module.
@@ -28,12 +28,11 @@
 /*!
     \example opcuaviewer
     \ingroup qtopcua-examples
-    \title Qt OPC UA explorer
-    \brief This example uses the model/view approach to display all nodes of an
-    OPC UA server in a \l QTreeView.
+    \title Qt OPC UA Viewer Example
+    \brief Using the model/view approach to display all nodes of an
+    OPC UA server in a tree view.
 
-    \section1 Introduction
-    This example uses the model/view approach to display all nodes of an
+    \e {Qt OPC UA Viewer} uses the model/view approach to display all nodes of an
     OPC UA server in a \l QTreeView.
 
     \image opcuaviewer.png
diff --git a/examples/opcua/waterpump/waterpump-qml/doc/waterpump-qml.qdoc b/examples/opcua/waterpump/waterpump-qml/doc/waterpump-qml.qdoc
index 982b3af..620f9d5 100644
--- a/examples/opcua/waterpump/waterpump-qml/doc/waterpump-qml.qdoc
+++ b/examples/opcua/waterpump/waterpump-qml/doc/waterpump-qml.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2019 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the documentation of the Qt Toolkit.
@@ -28,13 +28,12 @@
 /*!
     \example waterpump/waterpump-qml
     \ingroup qtopcua-examples
-    \title Example using the QML API for Qt OPC UA
-    \brief This example shows how to use Qt OPC UA QML API to interact with an OPC UA
-    server to build a QML based HMI for a simple machine.
+    \title Qt Quick Waterpump Example
+    \brief Interacting with an OPC UA server to build a QML-based HMI for a
+    simple machine.
 
-    \section1 Introduction
-    This example shows how to use Qt OPC UA QML API to interact with an OPC UA
-    server to build a QML based HMI for a simple machine.
+    \e{Qt Quick Waterpump} shows how to use Qt OPC UA QML API to interact with
+    an OPC UA server to build a QML based HMI for a simple machine.
 
     \section1 The Simulation
     The OPC UA server included in this example runs a simulation of a machine
@@ -108,7 +107,7 @@
 
     For example, the button to flush the second tank is enabled
     only if the backend is connected to the server, the machine is idle, and
-    the tank level is above the setpoint. On click, the flushTank2() method
+    the tank level is above the setpoint. On click, the \c flushTank2() method
     is called on the server.
 
     \quotefromfile waterpump/waterpump-qml/MachineDisplay.qml
diff --git a/examples/opcua/waterpump/waterpump-qmlcpp/doc/waterpump-qmlcpp.qdoc b/examples/opcua/waterpump/waterpump-qmlcpp/doc/waterpump-qmlcpp.qdoc
index 2dde20d..3211991 100644
--- a/examples/opcua/waterpump/waterpump-qmlcpp/doc/waterpump-qmlcpp.qdoc
+++ b/examples/opcua/waterpump/waterpump-qmlcpp/doc/waterpump-qmlcpp.qdoc
@@ -1,5 +1,6 @@
 /****************************************************************************
 **
+** Copyright (C) 2019 The Qt Company Ltd.
 ** Copyright (C) 2018 basysKom GmbH, info@basyskom.com
 ** Contact: https://www.qt.io/licensing/
 **
@@ -28,17 +29,16 @@
 /*!
     \example waterpump/waterpump-qmlcpp
     \ingroup qtopcua-examples
-    \title Using Qt OPC UA in a basic UI application
-    \brief This example shows how to use Qt OPC UA to interact with an OPC UA
-    server to build a QML based HMI for a simple machine.
+    \title Waterpump Example
+    \brief Interacting with an OPC UA server to build a QML-based HMI for a
+    simple machine.
 
-    \section1 Introduction
-    This example shows how to use Qt OPC UA to interact with an OPC UA
-    server to build a QML based HMI for a simple machine.
+    \e {Waterpump} shows how to use Qt OPC UA to interact with an
+    OPC UA server to build a QML-based HMI for a simple machine.
 
     \section1 The Simulation
     The OPC UA server included in this example runs a simulation of a machine
-    containing two tanks, a water pump and a valve. Water can be pumped from the
+    containing two tanks, a water pump, and a valve. Water can be pumped from the
     first tank into the second tank and then be flushed from the second tank
     by opening the valve. Both operations have a user-configurable setpoint
     which controls how much water is pumped to or flushed from the second tank.
@@ -83,17 +83,17 @@
 
     All methods return \l {QOpcUa::UaStatusCode} {Good} in case of success and
     \l {QOpcUa::UaStatusCode} {BadUserAccessDenied} if the operation is illegal
-    (e. g. trying to start the pump if the first tank is empty).
+    (for example, trying to start the pump if the first tank is empty).
 
-    \section1 Used Features of \l QOpcUaClient
-    This example uses read, write, method calls and data change subscriptions
+    \section1 Client Features
+    This example uses read, write, method calls, and data change subscriptions
     and shows how to set up handlers for the asynchronous operations offered
     by QOpcUaClient and QOpcUaNode.
 
     \section1 Implementation
 
     A backend class is used to handle the communication with the OPC UA server
-    and expose the content of this server by means of properties and Q_INVOKABLE
+    and expose the content of this server by means of properties and \c Q_INVOKABLE
     methods wrapping the OPC UA method calls.
 
     \section2 Member Variables
@@ -109,7 +109,7 @@
     \codeline
     \dots
 
-    For each value used in the HMI, a getter, a changed signal and a
+    For each value used in the HMI, a getter, a changed signal, and a
     property are added to enable property bindings in QML
 
     \quotefromfile waterpump/waterpump-qmlcpp/opcuamachinebackend.h
@@ -124,7 +124,7 @@
 
     Data change subscriptions report their updates using \l QOpcUaNode::attributeUpdated.
     A handler connected to this signal gets the new value as QVariant and can
-    e. g. write that value to a variable or emit a signal with the new value.
+    write that value to a variable or emit a signal with the new value, for example.
 
     \quotefromfile waterpump/waterpump-qmlcpp/opcuamachinebackend.cpp
     \skipto void OpcUaMachineBackend::percentFilledTank1Updated
@@ -140,7 +140,8 @@
 
     \section2 Interaction with the Server
 
-    In the constructor, a QOpcUaProvider is created and the available backends are saved to provide a model for the backend selection dropdown menu.
+    In the constructor, a QOpcUaProvider is created and the available backends
+    are saved to provide a model for the backend selection dropdown menu.
 
     \quotefromfile waterpump/waterpump-qmlcpp/opcuamachinebackend.cpp
     \dots
@@ -149,23 +150,27 @@
     \dots
 
     Before attempting a connection, a QOpcUaClient with the selected backend is created.
-    Its \l QOpcUaClient::endpointsRequestFinished signal is connected to the backend's requestEndpointsFinished slot.
-    The \l QOpcUaClient::stateChanged signal must be connected to the backend's clientStateHandler slot.
+    Its \l QOpcUaClient::endpointsRequestFinished signal is connected to the
+    backend's \c requestEndpointsFinished slot.
+    The \l QOpcUaClient::stateChanged signal must be connected to the backend's
+    \c clientStateHandler slot.
 
     \quotefromfile waterpump/waterpump-qmlcpp/opcuamachinebackend.cpp
     \skipto OpcUaMachineBackend::connectToEndpoint
     \printuntil m_client->requestEndpoints
     \printuntil }
 
-    The \l requestEndpointsFinished slot receives the list of available endpoints on the server and starts a connection
-    to the first entry in the list. If there are no available endpoints, the connection establishment is aborted.
+    The \c OpcUaMachineBackend::requestEndpointsFinished slot receives the list
+    of available endpoints on the server and starts a connection to the first
+    entry in the list. If there are no available endpoints, the connection
+    establishment is aborted.
 
     \quotefromfile waterpump/waterpump-qmlcpp/opcuamachinebackend.cpp
     \skipto void OpcUaMachineBackend::requestEndpointsFinished
     \printuntil m_client->connectToEndpoint
     \printuntil }
 
-    clientStateHandler acts on QOpcUaClient being connected or disconnected.
+    \c clientStateHandler acts on QOpcUaClient being connected or disconnected.
     In case of a successful connection, the node member variables created before
     are filled with node objects.
 
@@ -205,7 +210,7 @@
     \section2 The HMI
 
     A backend instance is created and handed to the QML part as a context property
-    named uaBackend.
+    named \c uaBackend.
 
     \dots
     \quotefromfile waterpump/waterpump-qmlcpp/main.cpp
@@ -213,10 +218,10 @@
     \printuntil setContextProperty
     \dots
 
-    The properties, signals and Q_INVOKABLE methods of uaBackend can now be accessed by
+    The properties, signals and \c Q_INVOKABLE methods of uaBackend can now be accessed by
     the QML code. For example, the button to flush the second tank is enabled
     only if the backend is connected to the server, the machine is idle and
-    the tank level is above the setpoint. On click, the flushTank2() method
+    the tank level is above the setpoint. On click, the \c flushTank2() method
     is called on the server.
 
     \quotefromfile waterpump/waterpump-qmlcpp/Tank2Unit.qml