summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Blasche <alexander.blasche@qt.io>2018-10-15 09:48:36 +0200
committerAlex Blasche <alexander.blasche@qt.io>2018-10-15 12:45:04 +0000
commit43a65b661f54755eb725e25112d62cb5eb726ac3 (patch)
tree0c2b38bbc0c4d20950e4e47914a40ae1a085897c
parent7577cd3fa7ebfa35b199d485233f3b41cec79e46 (diff)
Fix various QDoc warnings/errors in QtSerialBusv5.12.0-beta3
Change-Id: Iee3a9942657abf67c74aabd687b18af5f3e731f2 Reviewed-by: André Hartmann <aha_1980@gmx.de>
-rw-r--r--src/serialbus/doc/src/qtcanbus-backends.qdoc2
-rw-r--r--src/serialbus/doc/src/qtserialbus-module-cpp.qdoc4
-rw-r--r--src/serialbus/qcanbusdevice.cpp2
-rw-r--r--src/serialbus/qmodbusclient.cpp2
-rw-r--r--src/serialbus/qmodbuspdu.cpp15
5 files changed, 21 insertions, 4 deletions
diff --git a/src/serialbus/doc/src/qtcanbus-backends.qdoc b/src/serialbus/doc/src/qtcanbus-backends.qdoc
index e6b150f..03f8de3 100644
--- a/src/serialbus/doc/src/qtcanbus-backends.qdoc
+++ b/src/serialbus/doc/src/qtcanbus-backends.qdoc
@@ -67,7 +67,7 @@
\li CAN bus plugin using the SAE J2534 Pass-Thru interface.
\row
\li SYS TEC electronic
- \li \l {Using SystecCAN Backend}{SystecCAN} (\c systeccan)
+ \li \l {Using SystecCAN Plugin}{SystecCAN} (\c systeccan)
\li CAN bus backend using the SYS TEC CAN adapters.
\row
\li PEAK-System
diff --git a/src/serialbus/doc/src/qtserialbus-module-cpp.qdoc b/src/serialbus/doc/src/qtserialbus-module-cpp.qdoc
index 74123fc..57c81ea 100644
--- a/src/serialbus/doc/src/qtserialbus-module-cpp.qdoc
+++ b/src/serialbus/doc/src/qtserialbus-module-cpp.qdoc
@@ -46,7 +46,9 @@
The .pro file should have the \e serialbus keyword added
- \code QT += serialbus \endcode
+ \code
+ QT += serialbus
+ \endcode
See more in the \l {Qt Serial Bus} {Qt Serial Bus Overview}.
diff --git a/src/serialbus/qcanbusdevice.cpp b/src/serialbus/qcanbusdevice.cpp
index 6dc8abd..6723f77 100644
--- a/src/serialbus/qcanbusdevice.cpp
+++ b/src/serialbus/qcanbusdevice.cpp
@@ -684,7 +684,7 @@ QVector<QCanBusFrame> QCanBusDevice::readAllFrames()
*/
/*!
- \fn QString interpretErrorFrame(const QCanBusFrame &frame)
+ \fn QString QCanBusDevice::interpretErrorFrame(const QCanBusFrame &frame)
Interprets \a frame as error frame and returns a human readable
description of the error.
diff --git a/src/serialbus/qmodbusclient.cpp b/src/serialbus/qmodbusclient.cpp
index 0185544..32be316 100644
--- a/src/serialbus/qmodbusclient.cpp
+++ b/src/serialbus/qmodbusclient.cpp
@@ -160,7 +160,7 @@ int QModbusClient::timeout() const
This signal is emitted when the timeout used by this QModbusClient instance
is changed. The new response timeout for the device is passed as \a newTimeout.
- \sa setTimout()
+ \sa setTimeout()
*/
/*!
diff --git a/src/serialbus/qmodbuspdu.cpp b/src/serialbus/qmodbuspdu.cpp
index 350dc76..f2a3abc 100644
--- a/src/serialbus/qmodbuspdu.cpp
+++ b/src/serialbus/qmodbuspdu.cpp
@@ -490,6 +490,13 @@ QDataStream &operator<<(QDataStream &stream, const QModbusPdu &pdu)
*/
/*!
+ \typedef QModbusRequest::CalcFuncPtr
+
+ Typedef for a pointer to a custom calculator function with the same signature as
+ \l QModbusRequest::calculateDataSize.
+*/
+
+/*!
\fn QModbusRequest::QModbusRequest()
Constructs an invalid QModbusRequest.
@@ -637,6 +644,14 @@ QDataStream &operator>>(QDataStream &stream, QModbusRequest &pdu)
\endcode
*/
+
+/*!
+ \typedef QModbusResponse::CalcFuncPtr
+
+ Typedef for a pointer to a custom calculator function with the same signature as
+ \l QModbusResponse::calculateDataSize.
+*/
+
/*!
\fn QModbusResponse::QModbusResponse()