Doc: Fix documentation warnings

QDoc in Qt 5.11 uses Clang to parse C++ documentation, and it's capable
of resolving templated function signatures; adjust the \fn commands
accordingly.

Also fix a couple of other minor documentation warnings.

Change-Id: I867713a9e805b75bbd57e183aad91d7e21021f0a
Reviewed-by: Martin Smith <martin.smith@qt.io>

5 files changed, 14 insertions, 14 deletions

diff --git a/src/serialbus/doc/src/passthrucan.qdoc b/src/serialbus/doc/src/passthrucan.qdoc
index 740dbc4..21e6283 100644
--- a/src/serialbus/doc/src/passthrucan.qdoc
+++ b/src/serialbus/doc/src/passthrucan.qdoc
@@ -139,7 +139,7 @@
         \row
             \li QCanBusDevice::RawFilterKey
             \li This option allows setting up filters for incoming CAN bus messages.
-                If provided, the value should be a \l {QList<QCanBusDevice::Filter>}.
+                If provided, the value should be a \l {QList}<\l{QCanBusDevice::Filter}>.
                 Only data frame ID filters are supported. By default, data frames
                 with any ID are accepted.
         \row
diff --git a/src/serialbus/qcanbusdevice.cpp b/src/serialbus/qcanbusdevice.cpp
index b1c97a6..594eea5 100644
--- a/src/serialbus/qcanbusdevice.cpp
+++ b/src/serialbus/qcanbusdevice.cpp
@@ -209,9 +209,9 @@ Q_LOGGING_CATEGORY(QT_CANBUS, "qt.canbus")
 */
 
 /*!
-    \fn QCanBusDevice::errorOccurred(CanBusError error)
+    \fn void QCanBusDevice::errorOccurred(CanBusError)
 
-    This signal is emitted when an error of the type \a error occurs.
+    This signal is emitted when an error occurs.
 */
 
 /*!
diff --git a/src/serialbus/qcanbusframe.cpp b/src/serialbus/qcanbusframe.cpp
index 8644701..8ba0cc7 100644
--- a/src/serialbus/qcanbusframe.cpp
+++ b/src/serialbus/qcanbusframe.cpp
@@ -350,7 +350,7 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
-    \fn TimeStamp::TimeStamp(qint64 s, qint64 usec)
+    \fn QCanBusFrame::TimeStamp::TimeStamp(qint64 s, qint64 usec)
 
     Constructs a TimeStamp in seconds, \a s, and microseconds, \a usec.
 
@@ -359,7 +359,7 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
-    \fn static TimeStamp TimeStamp::fromMicroSeconds(qint64 usec)
+    \fn static TimeStamp QCanBusFrame::TimeStamp::fromMicroSeconds(qint64 usec)
 
     Constructs a normalized TimeStamp from microseconds \a usec.
 
@@ -368,13 +368,13 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
-    \fn qint64 TimeStamp::seconds() const
+    \fn qint64 QCanBusFrame::TimeStamp::seconds() const
 
     Returns the seconds of the timestamp.
 */
 
 /*!
-    \fn qint64 TimeStamp::microSeconds() const
+    \fn qint64 QCanBusFrame::TimeStamp::microSeconds() const
 
     Returns the microseconds of the timestamp.
 */
diff --git a/src/serialbus/qmodbuspdu.cpp b/src/serialbus/qmodbuspdu.cpp
index 03c4894..350dc76 100644
--- a/src/serialbus/qmodbuspdu.cpp
+++ b/src/serialbus/qmodbuspdu.cpp
@@ -312,7 +312,7 @@ static QDataStream &pduFromStream(QDataStream &stream, QModbusPdu &pdu, Type typ
 
 /*!
     \internal
-    \fn QModbusPdu::QModbusPdu(FunctionCode code, Args... data)
+    \fn template <typename ... Args> QModbusPdu::QModbusPdu(FunctionCode code, Args ... data)
 
     Constructs a QModbusPdu with function code set to \a code and payload set to \a data.
     The data is converted and stored in big-endian byte order.
@@ -397,7 +397,7 @@ static QDataStream &pduFromStream(QDataStream &stream, QModbusPdu &pdu, Type typ
 */
 
 /*!
-    \fn void QModbusPdu::decodeData(Args && ... data) const
+    \fn template <typename ... Args> void QModbusPdu::decodeData(Args && ... data) const
 
     Converts the payload into host endianness and reads it into \a data. Data can be a variable
     length argument list.
@@ -415,7 +415,7 @@ static QDataStream &pduFromStream(QDataStream &stream, QModbusPdu &pdu, Type typ
 */
 
 /*!
-    \fn void QModbusPdu::encodeData(Args ... data)
+    \fn template <typename ... Args> void QModbusPdu::encodeData(Args ... data)
 
     Sets the payload to \a data. The data is converted and stored in big-endian byte order.
 
@@ -502,7 +502,7 @@ QDataStream &operator<<(QDataStream &stream, const QModbusPdu &pdu)
 */
 
 /*!
-    \fn QModbusRequest::QModbusRequest(FunctionCode code, Args... data)
+    \fn template <typename ... Args> QModbusRequest::QModbusRequest(FunctionCode code, Args... data)
 
     Constructs a QModbusRequest with function code set to \a code and payload set to \a data.
     The data is converted and stored in big-endian byte order.
@@ -650,7 +650,7 @@ QDataStream &operator>>(QDataStream &stream, QModbusRequest &pdu)
 */
 
 /*!
-    \fn QModbusResponse::QModbusResponse(FunctionCode code, Args... data)
+    \fn template <typename ... Args> QModbusResponse::QModbusResponse(FunctionCode code, Args... data)
 
     Constructs a QModbusResponse with function code set to \a code and payload set to \a data.
     The data is converted and stored in big-endian byte order.
diff --git a/src/serialbus/qmodbusserver.cpp b/src/serialbus/qmodbusserver.cpp
index 815cb0c..4e16e1b 100644
--- a/src/serialbus/qmodbusserver.cpp
+++ b/src/serialbus/qmodbusserver.cpp
@@ -558,12 +558,12 @@ bool QModbusServer::readData(QModbusDataUnit *newData) const
 }
 
 /*!
-    \fn void QModbusServer::dataWritten(QModbusDataUnit::RegisterType register, int address, int size)
+    \fn void QModbusServer::dataWritten(QModbusDataUnit::RegisterType table, int address, int size)
 
     This signal is emitted when a Modbus client has written one or more fields of data to the
     Modbus server. The signal contains information about the fields that were written:
     \list
-        \li \a register type that was written,
+        \li Register type (\a table) that was written,
         \li \a address of the first field that was written,
         \li and \a size of consecutive fields that were written starting from \a address.
     \endlist