Fix references and mistakes in the docs

Some links could not be resolved and the documentation
for a function was missing.

Change-Id: I458b8deee6cdb21f5fd27a8ef450b6a3bef319d9
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
Reviewed-by: Frank Meerkoetter <frank.meerkoetter@basyskom.com>

6 files changed, 19 insertions, 9 deletions

diff --git a/src/opcua/client/qopcuaclient.cpp b/src/opcua/client/qopcuaclient.cpp
index 69c7231..ca17dec 100644
--- a/src/opcua/client/qopcuaclient.cpp
+++ b/src/opcua/client/qopcuaclient.cpp
@@ -140,6 +140,8 @@ Q_DECLARE_LOGGING_CATEGORY(QT_OPCUA)
     \fn void QOpcUaClient::namespaceArrayUpdated(QStringList namespaces)
 
     This signal is emitted after a updateNamespaceArray operation has finished.
+    \a namespaces contains the content of the server's namespace table. The index
+    of an entry in \a namespaces corresponds to the namespace index used in the node id.
 */
 
 /*!
diff --git a/src/opcua/client/qopcuanode.cpp b/src/opcua/client/qopcuanode.cpp
index da50505..4f79c66 100644
--- a/src/opcua/client/qopcuanode.cpp
+++ b/src/opcua/client/qopcuanode.cpp
@@ -189,7 +189,7 @@ QT_BEGIN_NAMESPACE
     This signal is emitted after a method call for \a methodNodeId has finished on the server.
     \a statusCode contains the status code from the method call, \a result contains the output
     arguments of the method. \a result is empty if the method has no output arguments or \a statusCode
-    is not OpcUa::UaStatusCode::Good.
+    is not \l {QOpcUa::UaStatusCode} {Good}.
 */
 
 /*!
@@ -198,8 +198,8 @@ QT_BEGIN_NAMESPACE
     This signal is emitted after a \l browseChildren() operation has finished.
 
     \a children contains information about all nodes which matched the criteria in \l browseChildren().
-    \a statusCode contains the service result of the browse operation. If \a statusCode is not QOpcUa::UaAttributeId::Good,
-    \a children is empty.
+    \a statusCode contains the service result of the browse operation. If \a statusCode is not \l {QOpcUa::UaStatusCode} {Good},
+    the passed \a children vector is empty.
     \sa QOpcUaReferenceDescription
 */
 
@@ -323,7 +323,7 @@ bool QOpcUaNode::enableMonitoring(QOpcUa::NodeAttributes attr, const QOpcUaMonit
     Returns \c true if the asynchronous call has been successfully dispatched.
 
     After the call has finished, the \l monitoringStatusChanged signal is emitted. This signal contains the modified parameters and the status code.
-    A bad status code is generated if there is no monitored item associated with the requested attribute, revising the requested
+    A bad status code is generated if there is no monitored item associated with the requested attribute, modifying the requested
     parameter is not implemented or if the server has rejected the requested value.
 */
 bool QOpcUaNode::modifyMonitoring(QOpcUa::NodeAttribute attr, QOpcUaMonitoringParameters::Parameter item, const QVariant &value)
@@ -476,7 +476,7 @@ bool QOpcUaNode::disableMonitoring(QOpcUa::NodeAttributes attr)
     Returns \c true if the asynchronous call has been successfully dispatched.
 
     To request only children connected to the node by a certain type of reference, \a referenceType must be set to that reference type.
-    For example, this can be  used to get all properties of a node by passing QOpcUa::ReferenceTypeId::HasProperty in \a referenceType.
+    For example, this can be  used to get all properties of a node by passing \l {QOpcUa::ReferenceTypeId} {HasProperty} in \a referenceType.
     The results can be filtered to contain only nodes with certain node classes by setting them in \a nodeClassMask.
 */
 bool QOpcUaNode::browseChildren(QOpcUa::ReferenceTypeId referenceType, QOpcUa::NodeClasses nodeClassMask)
diff --git a/src/opcua/client/qopcuatype.cpp b/src/opcua/client/qopcuatype.cpp
index 170851e..36ab059 100644
--- a/src/opcua/client/qopcuatype.cpp
+++ b/src/opcua/client/qopcuatype.cpp
@@ -810,4 +810,10 @@ QOpcUa::ErrorCategory QOpcUa::errorCategory(QOpcUa::UaStatusCode statusCode)
     Returns \c true if this QXValue has the same value as \a other.
 */
 
+/*!
+    \fn inline uint QOpcUa::qHash(const QOpcUa::NodeAttribute& attr)
+
+    Returns a \l QHash key for \a attr.
+*/
+
 QT_END_NAMESPACE
diff --git a/src/opcua/core/qopcuaprovider.cpp b/src/opcua/core/qopcuaprovider.cpp
index 000a26e..e2354e3 100644
--- a/src/opcua/core/qopcuaprovider.cpp
+++ b/src/opcua/core/qopcuaprovider.cpp
@@ -99,7 +99,7 @@ static QHash<QString, QJsonObject> loadPluginMetadata()
 /*!
     \fn static QHash<QString, QJsonObject> plugins()
 
-    Returns a QHash mapping names to JSON objects containing the meta data of
+    Returns a \l QHash mapping names to JSON objects containing the meta data of
     available plugins.
 */
 static QHash<QString, QJsonObject> plugins()
diff --git a/src/opcua/doc/qtopcua.qdocconf b/src/opcua/doc/qtopcua.qdocconf
index 5bd3437..42d4599 100644
--- a/src/opcua/doc/qtopcua.qdocconf
+++ b/src/opcua/doc/qtopcua.qdocconf
@@ -47,7 +47,9 @@ examplesinstallpath = qtopcua/opcua
 depends += \
    qtcore \
    qtqml \
-   qtquick
+   qtquick \
+   qtdoc \
+   qmake
 
 Cpp.ignoretokens   += \
    Q_OPCUA_EXPORT
diff --git a/src/opcua/doc/src/examples/waterpump.qdoc b/src/opcua/doc/src/examples/waterpump.qdoc
index 8773b01..d67b9a1 100644
--- a/src/opcua/doc/src/examples/waterpump.qdoc
+++ b/src/opcua/doc/src/examples/waterpump.qdoc
@@ -80,8 +80,8 @@
             \li Call this method to flush tank 2
     \endtable
 
-    All methods return \l QOpcUa::UaStatusCode::Good in case of success and
-    \l QOpcUa::UaStatusCode::BadUserAccessDenied if the operation is illegal
+    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).
 
     \section1 Used features of \l QOpcUaClient