summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJannis Voelker <jannis.voelker@basyskom.com>2018-03-06 13:20:26 +0100
committerFrank Meerkoetter <frank.meerkoetter@basyskom.com>2018-03-08 13:56:44 +0000
commit85c093b504a7f3e176cc922cd831ddb459ec94da (patch)
treeaf678e3446d3692ab441feeac88f232a9d001f92
parent8e0c9fb7fd63429d1e90e62131452d89d3f971ae (diff)
Fix references in the docs
The node id creation helpers were missing documentation for their parameters. The link to the plugin capabilities in the provider documentation referred to the wrong page. Change-Id: I1418e5d59c73b8a8e95c365449ec26fa9a1de2a7 Reviewed-by: Alex Blasche <alexander.blasche@qt.io> Reviewed-by: Frank Meerkoetter <frank.meerkoetter@basyskom.com>
-rw-r--r--src/opcua/client/qopcuatype.cpp8
-rw-r--r--src/opcua/core/qopcuaprovider.cpp2
2 files changed, 5 insertions, 5 deletions
diff --git a/src/opcua/client/qopcuatype.cpp b/src/opcua/client/qopcuatype.cpp
index 6ab01e5..5cbe77c 100644
--- a/src/opcua/client/qopcuatype.cpp
+++ b/src/opcua/client/qopcuatype.cpp
@@ -610,7 +610,7 @@ QOpcUa::ErrorCategory QOpcUa::errorCategory(QOpcUa::UaStatusCode statusCode)
}
/*!
- Creates a node id string from a namespace index and a string identifier.
+ Creates a node id string from the namespace index \a ns and the string \a identifier.
\sa QOpcUaNode
*/
QString QOpcUa::nodeIdFromString(quint16 ns, const QString &identifier)
@@ -619,7 +619,7 @@ QString QOpcUa::nodeIdFromString(quint16 ns, const QString &identifier)
}
/*!
- Creates a node id string from a namespace index and a byte string identifier.
+ Creates a node id string from the namespace index \a ns and the byte string \a identifier.
\sa QOpcUaNode
*/
QString QOpcUa::nodeIdFromByteString(quint16 ns, const QByteArray &identifier)
@@ -628,7 +628,7 @@ QString QOpcUa::nodeIdFromByteString(quint16 ns, const QByteArray &identifier)
}
/*!
- Creates a node id string from a namespace index and a GUID identifier.
+ Creates a node id string from the namespace index \a ns and the GUID \a identifier.
\sa QOpcUaNode
*/
QString QOpcUa::nodeIdFromGuid(quint16 ns, const QUuid &identifier)
@@ -637,7 +637,7 @@ QString QOpcUa::nodeIdFromGuid(quint16 ns, const QUuid &identifier)
}
/*!
- Creates a node id string from a namespace index and a numeric identifier.
+ Creates a node id string from the namespace index \a ns and the integer \a identifier.
\sa QOpcUaNode
*/
QString QOpcUa::nodeIdFromInteger(quint16 ns, quint32 identifier)
diff --git a/src/opcua/core/qopcuaprovider.cpp b/src/opcua/core/qopcuaprovider.cpp
index e2354e3..75d8c20 100644
--- a/src/opcua/core/qopcuaprovider.cpp
+++ b/src/opcua/core/qopcuaprovider.cpp
@@ -60,7 +60,7 @@ Q_LOGGING_CATEGORY(QT_OPCUA, "qt.opcua")
loading a QOpcUaPlugin using the Qt plugin system.
For the available plugins and their capabilities please refer to the
- \l QOpcUaClient documentation.
+ \l {Qt OPC UA} {introduction}.
\section1 Example
This code creates a client using the first available backend: