summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorJannis Voelker <jannis.voelker@basyskom.com>2018-07-17 10:35:05 +0200
committerJannis Völker <jannis.voelker@basyskom.com>2018-07-17 08:58:23 +0000
commit7355b393dfb35ef7df68b39417a47dd57c3c721f (patch)
treef4e095df23d54ef1a9a3abd0a89819bf91fbbd4a /src
parent6e330b898b7bd9ac7295a9b9a6687a730eb0f81e (diff)
Fix qdoc warnings
Change-Id: I32ff7f582da89ff1b99d8097eb373fa8a0dd0a71 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/opcua/client/qopcuamonitoringparameters.cpp8
-rw-r--r--src/opcua/client/qopcuatype.cpp25
-rw-r--r--src/opcua/core/qopcuaprovider.cpp2
3 files changed, 18 insertions, 17 deletions
diff --git a/src/opcua/client/qopcuamonitoringparameters.cpp b/src/opcua/client/qopcuamonitoringparameters.cpp
index 4599d06..0e88b46 100644
--- a/src/opcua/client/qopcuamonitoringparameters.cpp
+++ b/src/opcua/client/qopcuamonitoringparameters.cpp
@@ -641,7 +641,7 @@ QOpcUaMonitoringParameters::DataChangeFilter::operator QVariant() const
\class QOpcUaMonitoringParameters::EventFilter
\inmodule QtOpcUa
\inheaderfile QOpcUaMonitoringParameters
- \brief Defines an EventFilter for a monitored item
+ \brief Defines an EventFilter for a monitored item.
An event filter is required for monitoring events on the server.
It consists of \c select clauses and a \c where clause.
@@ -690,7 +690,7 @@ QOpcUaMonitoringParameters::EventFilter::EventFilter()
}
/*!
- Constructs an \l event filter from \a rhs.
+ Constructs an event filter from \a rhs.
*/
QOpcUaMonitoringParameters::EventFilter::EventFilter(const QOpcUaMonitoringParameters::EventFilter &rhs)
: data(rhs.data)
@@ -726,7 +726,7 @@ QOpcUaMonitoringParameters::EventFilter &QOpcUaMonitoringParameters::EventFilter
}
/*!
- Converts this \l event filter to \l QVariant.
+ Converts this event filter to \l QVariant.
*/
QOpcUaMonitoringParameters::EventFilter::operator const QVariant()
{
@@ -748,7 +748,7 @@ QVector<QOpcUa::QContentFilterElement> QOpcUaMonitoringParameters::EventFilter::
/*!
Returns a reference to the where clause.
- \sa whereClause().
+ \sa whereClause()
*/
QVector<QOpcUa::QContentFilterElement> &QOpcUaMonitoringParameters::EventFilter::whereClauseRef()
{
diff --git a/src/opcua/client/qopcuatype.cpp b/src/opcua/client/qopcuatype.cpp
index bb5fed6..863b7df 100644
--- a/src/opcua/client/qopcuatype.cpp
+++ b/src/opcua/client/qopcuatype.cpp
@@ -172,6 +172,7 @@ QT_BEGIN_NAMESPACE
\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 ExpandedNodeId A node id with additional namespace URI and server index.
\value Undefined
*/
@@ -1935,7 +1936,7 @@ void QOpcUa::QBrowsePathTarget::setTargetId(const QOpcUa::QExpandedNodeId &value
\class QOpcUa::QContentFilterElement
\inmodule QtOpcUa
\inheaderfile QtOpcUa/qopcuatype.h
- \brief The OPC UA ContentFilterElement
+ \brief The OPC UA ContentFilterElement.
A content filter element contains an operator and a list of operands.
There are four different operator types which contain literal values, references to
@@ -2110,7 +2111,7 @@ QOpcUa::QContentFilterElement &QOpcUa::QContentFilterElement::operator<<(const Q
\class QOpcUa::QElementOperand
\inmodule QtOpcUa
\inheaderfile QtOpcUa/qopcuatype.h
- \brief The OPC UA ElementOperand type
+ \brief The OPC UA ElementOperand type.
The ElementOperand is defined in OPC-UA part 4, 7.4.4.2.
It is used to identify another element in the filter by its index
@@ -2210,7 +2211,7 @@ void QOpcUa::QElementOperand::setIndex(const quint32 &value)
\class QOpcUa::QLiteralOperand
\inmodule QtOpcUa
\inheaderfile QtOpcUa/qopcuatype.h
- \brief The OPC UA LiteralOperand type
+ \brief The OPC UA LiteralOperand type.
The LiteralOperand is defined in OPC-UA part 4, 7.4.4.3.
It contains a literal value that is to be used as operand.
@@ -2304,7 +2305,7 @@ void QOpcUa::QLiteralOperand::setValue(const QVariant &value)
\class QOpcUa::QSimpleAttributeOperand
\inmodule QtOpcUa
\inheaderfile QtOpcUa/qopcuatype.h
- \brief The OPC UA SimpleAttributeOperand type
+ \brief The OPC UA SimpleAttributeOperand type.
The SimpleAttributeOperand is specified in OPC-UA part 4, 7.4.4.5.
It is used when a node attribute is required as operand.
@@ -2338,7 +2339,7 @@ QOpcUa::QSimpleAttributeOperand::QSimpleAttributeOperand(const QOpcUa::QSimpleAt
}
/*!
- Constructs a simple attribute operand for attribute \a attribute of the direct child with the browse name
+ Constructs a simple attribute operand for attribute \a attributeId of the direct child with the browse name
\a name in namespace \a namespaceIndex. \a typeId is the node id of a type definition node. The operand will
be restricted to instances of type \a typeId or a subtype.
*/
@@ -2426,7 +2427,7 @@ QVector<QOpcUa::QQualifiedName> QOpcUa::QSimpleAttributeOperand::browsePath() co
/*!
Returns a reference to the browse path.
- \sa browsePath().
+ \sa browsePath()
*/
QVector<QOpcUa::QQualifiedName> &QOpcUa::QSimpleAttributeOperand::browsePathRef()
{
@@ -2461,7 +2462,7 @@ void QOpcUa::QSimpleAttributeOperand::setTypeId(const QString &value)
\class QOpcUa::QAttributeOperand
\inmodule QtOpcUa
\inheaderfile QtOpcUa/qopcuatype.h
- \brief The OPC UA AttributeOperand type
+ \brief The OPC UA AttributeOperand type.
The AttributeOperand is defined in OPC-UA part 4, 7.4.4.4.
It has the same purpose as \l QSimpleAttributeOperand but has more configurable options.
@@ -2607,7 +2608,7 @@ void QOpcUa::QAttributeOperand::setNodeId(const QString &value)
\class QOpcUa::QContentFilterElementResult
\inmodule QtOPcUa
\inheaderfile QtOpcUa/qopcuatype.h
- \brief The OPC UA ContentFilterElementResult
+ \brief The OPC UA ContentFilterElementResult.
QContentFilterElementResult contains the status code for a
filter element and all its operands.
@@ -2693,7 +2694,7 @@ QVector<QOpcUa::UaStatusCode> &QOpcUa::QContentFilterElementResult::operandStatu
\class QOpcUa::QEventFilterResult
\inmodule QtOpcUa
\inheaderfile QtOpcUa/qopcuatype.h
- \brief The OPCUA EventFilterResult
+ \brief The OPCUA EventFilterResult.
The EventFilterResult contains status codes for all elements of the \c select clauses
and all elements of the \c where clause.
@@ -2810,7 +2811,7 @@ void QOpcUa::QEventFilterResult::setSelectClauseResults(const QVector<QOpcUa::Ua
\class QOpcUa::QUserTokenPolicy
\inmodule QtOpcUa
\inheaderfile QtOpcUa/qopcuatype.h
- \brief The OPC UA UserTokenPolicy
+ \brief The OPC UA UserTokenPolicy.
The user token policy contains information about an user token accepted by the server.
*/
@@ -2945,7 +2946,7 @@ void QOpcUa::QUserTokenPolicy::setPolicyId(const QString &value)
\class QOpcUa::QApplicationDescription
\inmodule QtOpcUa
\inheaderfile QtOpcUa/qopcuatype.h
- \brief The OPC UA ApplicationDescription
+ \brief The OPC UA ApplicationDescription.
The application description contains information about an OPC UA application.
*/
@@ -3121,7 +3122,7 @@ void QOpcUa::QApplicationDescription::setApplicationUri(const QString &value)
\class QOpcUa::QEndpointDescription
\inmodule QtOpcUa
\inheaderfile QtOpcUa/qopcuatype.h
- \brief The OPC UA EndpointDescription
+ \brief The OPC UA EndpointDescription.
An endpoint description contains information about an endpoint and how to connect to it.
*/
diff --git a/src/opcua/core/qopcuaprovider.cpp b/src/opcua/core/qopcuaprovider.cpp
index ded1778..4c7a799 100644
--- a/src/opcua/core/qopcuaprovider.cpp
+++ b/src/opcua/core/qopcuaprovider.cpp
@@ -54,7 +54,7 @@ Q_LOGGING_CATEGORY(QT_OPCUA, "qt.opcua")
\class QOpcUaProvider
\inmodule QtOpcUa
- \brief QOpcUaProvider creates an instance of QOpcUaClient
+ \brief QOpcUaProvider creates an instance of QOpcUaClient.
QOpcUaProvider allows the user to create an instance of QOpcUaClient by
loading a QOpcUaPlugin using the Qt plugin system.