Fix qdoc errors

This patch fixes several errors pointed out by make docs.

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

4 files changed, 126 insertions, 89 deletions

diff --git a/src/opcua/client/qopcuamonitoringparameters.cpp b/src/opcua/client/qopcuamonitoringparameters.cpp
index 6d1f5fe..28c6b7a 100644
--- a/src/opcua/client/qopcuamonitoringparameters.cpp
+++ b/src/opcua/client/qopcuamonitoringparameters.cpp
@@ -69,9 +69,9 @@ QT_BEGIN_NAMESPACE
 /*!
     \enum QOpcUaMonitoringParameters::Parameter
 
-    Enumerates parameters that can be modified at runtime using \l modifyMonitoring().
+    Enumerates parameters that can be modified at runtime using \l QOpcUaNode::modifyMonitoring().
     Not all values are guaranteed to be supported by all plugins. Lack of support will be reported
-    in the \l monitoringStatusChanged signal.
+    in the \l QOpcUaNode::monitoringStatusChanged signal.
 
     \value PublishingEnabled
     \value PublishingInterval
@@ -302,7 +302,7 @@ quint32 QOpcUaMonitoringParameters::subscriptionId() const
 }
 
 /*!
-    Request the monitored items to be created on a known subscription with subscriptionId \a value.
+    Request the monitored items to be created on a known subscription with \a subscriptionId.
 */
 void QOpcUaMonitoringParameters::setSubscriptionId(quint32 subscriptionId)
 {
diff --git a/src/opcua/client/qopcuanode.cpp b/src/opcua/client/qopcuanode.cpp
index d60a27e..a5a3867 100644
--- a/src/opcua/client/qopcuanode.cpp
+++ b/src/opcua/client/qopcuanode.cpp
@@ -122,49 +122,59 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
-    \fn QOpcUaNode::attributeWritten(QOpcUa::NodeAttribute attribute, QOpcUa::UaStatusCode statusCode)
+    \fn void QOpcUaNode::attributeWritten(QOpcUa::NodeAttribute attribute, QOpcUa::UaStatusCode statusCode)
 
     This signal is emitted after a \l writeAttribute(), \l writeAttributes() or \l writeAttributeRange()
     operation has finished.
 
     Before this signal is emitted, the attribute cache is updated in case of a successful write.
     For \l writeAttributes() a signal is emitted for each attribute in the write call.
+    \a statusCode contains the success information for the write operation on \a attribute.
 */
 
 /*!
-    \fn void enableMonitoringFinished(QOpcUa::NodeAttribute attr, QOpcUa::UaStatusCode statusCode)
+    \fn void QOpcUaNode::attributeUpdated(QOpcUa::NodeAttribute attr, QVariant value)
+
+    This signal is emitted after a data change notification has been received. \a value contains the
+    new value for the node attribute \a attr.
+*/
+
+/*!
+    \fn void QOpcUaNode::enableMonitoringFinished(QOpcUa::NodeAttribute attr, QOpcUa::UaStatusCode statusCode)
 
     This signal is emitted after an asynchronous call to \l enableMonitoring() has finished.
     After this signal has been emitted, \l monitoringStatus() returns valid information for \a attr.
+    \a statusCode contains the status code for the operation.
 */
 
 /*!
-    \fn void disableMonitoringFinished(QOpcUa::NodeAttribute attr, QOpcUa::UaStatusCode statusCode)
+    \fn void QOpcUaNode::disableMonitoringFinished(QOpcUa::NodeAttribute attr, QOpcUa::UaStatusCode statusCode)
 
-    This signal is emitted after an asynchronous call to \l disableMonitoring() has finished.
+    This signal is emitted after an asynchronous call to \l disableMonitoring() has finished. \a statusCode contains
+    the status code generated by the operation.
     After this signal has been emitted, monitoringStatus returns a default constructed value with
     status code BadMonitoredItemIdIinvalid for \a attr.
 */
 
 /*!
-    \fn void QOpcUaNode::monitoringStatusChanged(QOpcUa::NodeAttribute attr, QOpcUaMonitoringParameters::Parameter item, QVariant value, QOpcUa::UaStatusCode statusCode);
+    \fn void QOpcUaNode::monitoringStatusChanged(QOpcUa::NodeAttribute attr, QOpcUaMonitoringParameters::Parameters items, QOpcUa::UaStatusCode statusCode);
 
     This signal is emitted after an asynchronous call to \l modifyMonitoring() has finished.
-    The node attribute for which the operation was requested is returned in \a attr. \a item contains the parameters that have been modified.
+    The node attribute for which the operation was requested is returned in \a attr. \a items contains the parameters that have been modified.
     \a statusCode contains the result of the modify operation on the server.
 */
 
 /*!
-    \fn void methodCallFinished(QString methodNodeId, QVariant result, QOpcUa::UaStatusCode statusCode)
+    \fn void QOpcUaNode::methodCallFinished(QString methodNodeId, QVariant result, QOpcUa::UaStatusCode statusCode)
 
-    This signal is emitted after a method call has finished on the server.
+    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.
 */
 
 /*!
-    \fn void browseFinished(QVector<QOpcUaReferenceDescription> children, QOpcUa::UaStatusCode statusCode)
+    \fn void QOpcUaNode::browseFinished(QVector<QOpcUaReferenceDescription> children, QOpcUa::UaStatusCode statusCode)
 
     This signal is emitted after a \l browseChildren() operation has finished.
 
@@ -175,6 +185,18 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
+    \fn QOpcUa::NodeAttributes QOpcUaNode::mandatoryBaseAttributes()
+
+    Contains all mandatory attributes of the OPC UA base node class.
+*/
+
+/*!
+    \fn QOpcUa::NodeAttributes QOpcUaNode::allBaseAttributes()
+
+    Contains all attributes of the OPC UA base node class.
+*/
+
+/*!
     \internal QOpcUaNodeImpl is an opaque type (as seen from the public API).
     This prevents users of the public API to use this constructor (eventhough
     it is public).
@@ -256,6 +278,63 @@ QOpcUa::UaStatusCode QOpcUaNode::attributeError(QOpcUa::NodeAttribute attribute)
 }
 
 /*!
+    This method creates a monitored item for each of the attributes given in \a attr.
+    The settings from \a settings are used in the creation of the monitored items and the subscription.
+
+    Returns true if the asynchronous call has been successfully dispatched.
+
+    On completion of the call, the \l enableMonitoringFinished signal is emitted.
+    There are multiple error cases in which a bad status code is generated: A subscription with the subscription id specified in \a settings does not exist,
+    the node does not exist on the server, the node does not have the requested attribute or the maximum number of monitored items for
+    the server is reached.
+ */
+bool QOpcUaNode::enableMonitoring(QOpcUa::NodeAttributes attr, const QOpcUaMonitoringParameters &settings)
+{
+    Q_D(QOpcUaNode);
+    if (d->m_client.isNull() || d->m_client->state() != QOpcUaClient::Connected)
+        return false;
+
+    return d->m_impl->enableMonitoring(attr, settings);
+}
+
+/*!
+    This method modifies settings of the monitored item or the subscription.
+    The parameter \a item of the monitored item or subscription associated with \a attr is attempted to set to \a value.
+
+    Returns 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
+    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)
+{
+    Q_D(QOpcUaNode);
+    if (d->m_client.isNull() || d->m_client->state() != QOpcUaClient::Connected)
+        return false;
+
+    return d->m_impl->modifyMonitoring(attr, item, value);
+}
+
+/*!
+    Returns the monitoring parameters associated with the attribute \a attr. This can be used to check the success of \l enableMonitoring()
+    or if parameters have been revised.
+    The returned values are only valid after \l enableMonitoringFinished or \l monitoringStatusChanged have been emitted for \a attr.
+*/
+QOpcUaMonitoringParameters QOpcUaNode::monitoringStatus(QOpcUa::NodeAttribute attr)
+{
+    Q_D(QOpcUaNode);
+    auto it = d->m_monitoringStatus.constFind(attr);
+    if (it == d->m_monitoringStatus.constEnd()) {
+        QOpcUaMonitoringParameters p;
+        p.setStatusCode(QOpcUa::UaStatusCode::BadAttributeIdInvalid);
+        return p;
+    }
+
+    return *it;
+}
+
+/*!
     Writes \a value to the attribute given in \a attribute using the type information from \a type.
     Returns true if the asynchronous call has been successfully dispatched.
 
@@ -312,74 +391,6 @@ QOpcUa::UaStatusCode QOpcUaNode::attributeError(QOpcUa::NodeAttribute attribute)
     \endtable
 */
 
-/*!
-    This method creates a monitored item for each of the attributes given in \a attr.
-    The settings from \a settings are used in the creation of the monitored items and the subscription.
-
-    The \a shared field of \a settings controls how the monitored items are assigned to a subscription. If shared in \a settings is set to Shared,
-    the monitored item will be added to a subscription with a matching \a interval. If shared in \a settings is set to Exclusive,
-    either a new subscription is created, or if a subscription is provided via the subscriptionId field in \a settings, an existing subscription is used.
-    This can be used to group monitored items on a subscription manually by creating the first monitored item with \a shared=false and
-    using the subscriptionId returned in \a subscriptionId of monitoringStatus(\a attr) in the following requests.
-
-    Returns true if the asynchronous call has been successfully dispatched.
-
-    On the completion of the call, the \l enableMonitoringFinished signal is emitted.
-    There are multiple error cases in which a Bad status code is generated: A subscription with \a subscriptionId does not exist,
-    the node does not exist on the server, the node does not have the requested attribute or the maximum number of monitored items for
-    the server is reached.
- */
-bool QOpcUaNode::enableMonitoring(QOpcUa::NodeAttributes attr, const QOpcUaMonitoringParameters &settings)
-{
-    Q_D(QOpcUaNode);
-    if (d->m_client.isNull() || d->m_client->state() != QOpcUaClient::Connected)
-        return false;
-
-    return d->m_impl->enableMonitoring(attr, settings);
-}
-
-/*!
-    This method modifies settings of the monitored item or the subscription.
-    The parameter \a item of the monitored item or subscription associated with \a attr is attempted to set to \a value.
-
-    Returns true if the asynchronous call has been successfully dispatched.
-
-    After the call has finished, the 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
-    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)
-{
-    Q_D(QOpcUaNode);
-    if (d->m_client.isNull() || d->m_client->state() != QOpcUaClient::Connected)
-        return false;
-
-    return d->m_impl->modifyMonitoring(attr, item, value);
-}
-
-/*!
-    Returns the monitoring parameters associated with the attribute \a attr. This can be used to check the success of \l enableMonitoring()
-    or if parameters have been revised.
-    The returned values are only valid after \l enableMonitoringFinished or \l monitoringStatusChanged have been emitted for \a attr.
-*/
-QOpcUaMonitoringParameters QOpcUaNode::monitoringStatus(QOpcUa::NodeAttribute attr)
-{
-    Q_D(QOpcUaNode);
-    auto it = d->m_monitoringStatus.constFind(attr);
-    if (it == d->m_monitoringStatus.constEnd()) {
-        QOpcUaMonitoringParameters p;
-        p.setStatusCode(QOpcUa::UaStatusCode::BadAttributeIdInvalid);
-        return p;
-    }
-
-    return *it;
-}
-
-/*!
-    Writes \value to the attribute given in \a attribute using the type information from \a type.
-
-    Returns true if the write operation has been dispatched successfully.
- */
 bool QOpcUaNode::writeAttribute(QOpcUa::NodeAttribute attribute, const QVariant &value, QOpcUa::Types type)
 {
     Q_D(QOpcUaNode);
diff --git a/src/opcua/client/qopcuareferencedescription.cpp b/src/opcua/client/qopcuareferencedescription.cpp
index 9e68b68..dc667d3 100644
--- a/src/opcua/client/qopcuareferencedescription.cpp
+++ b/src/opcua/client/qopcuareferencedescription.cpp
@@ -56,14 +56,14 @@ QOpcUaReferenceDescription::QOpcUaReferenceDescription()
 {}
 
 /*!
-    Creates a copy of another QOpcUaReferenceDescription object
+    Creates a copy of the QOpcUaReferenceDescription object \a other.
 */
 QOpcUaReferenceDescription::QOpcUaReferenceDescription(const QOpcUaReferenceDescription &other)
     : d_ptr(other.d_ptr)
 {}
 
 /*!
-    Compares this object to another QOpcUaReferenceDescription object
+    Compares this object to QOpcUaReferenceDescription object \a other.
 */
 QOpcUaReferenceDescription &QOpcUaReferenceDescription::operator=(const QOpcUaReferenceDescription &other)
 {
@@ -86,7 +86,7 @@ QOpcUa::NodeClass QOpcUaReferenceDescription::nodeClass() const
 }
 
 /*!
-    Sets the node class of the node.
+    Sets the node class of the node to \a nodeClass.
 */
 void QOpcUaReferenceDescription::setNodeClass(QOpcUa::NodeClass nodeClass)
 {
@@ -103,7 +103,7 @@ QOpcUa::QLocalizedText QOpcUaReferenceDescription::displayName() const
 }
 
 /*!
-    Sets the display name of the node.
+    Sets the display name of the node to \a displayName.
 */
 void QOpcUaReferenceDescription::setDisplayName(const QOpcUa::QLocalizedText &displayName)
 {
@@ -119,7 +119,7 @@ QOpcUa::QQualifiedName QOpcUaReferenceDescription::browseName() const
 }
 
 /*!
-    Sets the browse name of the node.
+    Sets the browse name of the node to \a browseName.
 */
 void QOpcUaReferenceDescription::setBrowseName(const QOpcUa::QQualifiedName &browseName)
 {
@@ -135,7 +135,7 @@ QString QOpcUaReferenceDescription::nodeId() const
 }
 
 /*!
-    Sets the node id of the node.
+    Sets the node id of the node to \a nodeId.
 */
 void QOpcUaReferenceDescription::setNodeId(const QString &nodeId)
 {
@@ -151,7 +151,7 @@ QOpcUa::ReferenceTypeId QOpcUaReferenceDescription::refType() const
 }
 
 /*!
-    Sets the reference type of the node.
+    Sets the reference type of the node to \a refType.
 */
 void QOpcUaReferenceDescription::setRefType(QOpcUa::ReferenceTypeId refType)
 {
diff --git a/src/opcua/client/qopcuatype.cpp b/src/opcua/client/qopcuatype.cpp
index 892b1f7..0bdbdc7 100644
--- a/src/opcua/client/qopcuatype.cpp
+++ b/src/opcua/client/qopcuatype.cpp
@@ -160,6 +160,8 @@ QT_BEGIN_NAMESPACE
     \value ExtensionObject A data structure which contains a serialized object.
     \value Range A range composed from the two double values low and high.
     \value EUInformation The unit of measurement for an analog value.
+    \value ComplexNumber The OPC UA ComplexNumber type.
+    \value DoubleComplexNumber The OPC UA DoubleComplexNumber type.
     \value AxisInformation Information about an axis.
     \value XV A float value with a double precision position on an axis.
     \value Undefined
@@ -440,9 +442,15 @@ bool QOpcUa::isSuccessStatus(QOpcUa::UaStatusCode statusCode)
 */
 
 /*!
-    \fn QOpcUa::QQualifiedName::QQualifiedName(quint16 idx, QString text)
+    \fn QOpcUa::QQualifiedName::QQualifiedName(quint16 p_namespaceIndex, const QString &p_name)
 
-    Constructs an instance of QQualifiedName with the namespace index given in \a idx and the name given in \a text.
+    Constructs an instance of QQualifiedName with the namespace index given in \a p_namespaceIndex and the name given in \a p_name.
+*/
+
+/*!
+    \fn bool QOpcUa::QQualifiedName::operator==(const QQualifiedName &other) const
+
+    Compares this QQualifiedName to \a other.
 */
 
 /*!
@@ -474,6 +482,12 @@ bool QOpcUa::isSuccessStatus(QOpcUa::UaStatusCode statusCode)
 */
 
 /*!
+    \fn bool QOpcUa::QLocalizedText::operator==(const QLocalizedText &other) const
+
+    Compares this QLocalizedText to \a other.
+*/
+
+/*!
     \variable QOpcUa::QLocalizedText::text
 
     The text string of the QLocalizedText.
@@ -616,6 +630,12 @@ QOpcUa::ErrorCategory QOpcUa::errorCategory(QOpcUa::UaStatusCode statusCode)
 */
 
 /*!
+    \fn bool QOpcUa::QEUInformation::operator==(const QEUInformation &other) const
+
+    Compares this QEUInformation to \a other.
+*/
+
+/*!
     \variable QOpcUa::QEUInformation::namespaceUri
 
     The namespace URI of the unit.
@@ -698,6 +718,12 @@ QOpcUa::ErrorCategory QOpcUa::errorCategory(QOpcUa::UaStatusCode statusCode)
 */
 
 /*!
+    \fn bool QOpcUa::QAxisInformation::operator==(const QAxisInformation &other) const
+
+    Compares this QAxisInformation to \a other.
+*/
+
+/*!
     \variable QOpcUa::QAxisInformation::engineeringUnits
 
     The engineering units of this axis.