diff options
author | Rainer Keller <Rainer.Keller@qt.io> | 2018-07-23 10:19:07 +0200 |
---|---|---|
committer | Rainer Keller <Rainer.Keller@qt.io> | 2018-07-31 08:46:35 +0000 |
commit | b8d422bef67133c2532e6437c284becd5399b6a6 (patch) | |
tree | 78b110ef4ce9b582457f012ec79e219ef0914192 /examples | |
parent | 8fff342e252213739a81a889b5e2024050c615c8 (diff) |
doc: Small fixes in example documentation
Change-Id: I620a0f77b7751219f54dedd56c9c1b4dfeeea116
Reviewed-by: Jannis Völker <jannis.voelker@basyskom.com>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Diffstat (limited to 'examples')
-rw-r--r-- | examples/opcua/opcuaviewer/doc/opcuaviewer.qdoc | 2 | ||||
-rw-r--r-- | examples/opcua/waterpump/waterpump-qmlcpp/doc/waterpump-qmlcpp.qdoc | 20 |
2 files changed, 13 insertions, 9 deletions
diff --git a/examples/opcua/opcuaviewer/doc/opcuaviewer.qdoc b/examples/opcua/opcuaviewer/doc/opcuaviewer.qdoc index da01329..f6502ee 100644 --- a/examples/opcua/opcuaviewer/doc/opcuaviewer.qdoc +++ b/examples/opcua/opcuaviewer/doc/opcuaviewer.qdoc @@ -29,6 +29,8 @@ \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. \section1 Introduction This example uses the model/view approach to display all nodes of an diff --git a/examples/opcua/waterpump/waterpump-qmlcpp/doc/waterpump-qmlcpp.qdoc b/examples/opcua/waterpump/waterpump-qmlcpp/doc/waterpump-qmlcpp.qdoc index 0d963ff..51f5e89 100644 --- a/examples/opcua/waterpump/waterpump-qmlcpp/doc/waterpump-qmlcpp.qdoc +++ b/examples/opcua/waterpump/waterpump-qmlcpp/doc/waterpump-qmlcpp.qdoc @@ -29,12 +29,14 @@ \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. \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. - \section1 The simulation + \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 first tank into the second tank and then be flushed from the second tank @@ -83,7 +85,7 @@ \l {QOpcUa::UaStatusCode} {BadUserAccessDenied} if the operation is illegal (e. g. trying to start the pump if the first tank is empty). - \section1 Used features of \l QOpcUaClient + \section1 Used Features of \l QOpcUaClient 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. @@ -94,7 +96,7 @@ and expose the content of this server by means of properties and Q_INVOKABLE methods wrapping the OPC UA method calls. - \section2 Member variables + \section2 Member Variables A pointer to \l QOpcUaClient is required for connection management. An additional pointer to a \l QOpcUaNode object is needed for each OPC UA node the HMI interacts with. For the values of these nodes, member variables @@ -116,7 +118,7 @@ \printuntil QString message \dots - \section2 Asynchronous handlers + \section2 Asynchronous Handlers The asynchronous API of Qt OPC UA requires signal handlers for all operations. @@ -136,7 +138,7 @@ \printuntil } \printuntil } - \section2 Interaction with the server + \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. @@ -222,12 +224,12 @@ \section1 Usage The server is started automatically by the HMI application. - After connecting to the server by clicking the "Connect" button, - drag the slider to set a setpoint, then click "Start" to start pumping water + After connecting to the server by clicking the \uicontrol Connect button, + drag the slider to set a setpoint, then click \uicontrol Start to start pumping water from the first tank to the second tank. After setting a setpoint lower than - the current value of the second tank, a click on "Flush" opens the valve. + the current value of the second tank, a click on \uicontrol Flush opens the valve. - If there is no water left, click "Reset simulation" to refill the first tank. + If there is no water left, click \uicontrol {Reset simulation} to refill the first tank. \image tankexample.jpg */ |