summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndre Hartmann <aha_1980@gmx.de>2018-10-02 08:29:13 +0200
committerAndré Hartmann <aha_1980@gmx.de>2018-10-02 08:37:50 +0000
commitb5c415eb612d05f7fe690eff361a616d0cabbc7e (patch)
treea04cdbb88205509ae1e53df2e5613d41fd7fb241
parent71966594c3ed75f5a863fc99956aca90d3b08655 (diff)
Modbus: Fix documentation for QModbusClient::timeoutChanged()
It is not the response for an timeout, but rather the response whenever the timeout was changed. Change-Id: Id687429f7acdd487f87a63c4c1d51d2fc3cea1f9 Reviewed-by: Martin Smith <martin.smith@qt.io> Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
-rw-r--r--src/serialbus/qmodbusclient.cpp8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/serialbus/qmodbusclient.cpp b/src/serialbus/qmodbusclient.cpp
index 077b2ec..0185544 100644
--- a/src/serialbus/qmodbusclient.cpp
+++ b/src/serialbus/qmodbusclient.cpp
@@ -157,8 +157,10 @@ int QModbusClient::timeout() const
/*!
\fn void QModbusClient::timeoutChanged(int newTimeout)
- This signal is emitted if the response is not received within the required
- timeout. The new response timeout for the device is passed as \a newTimeout.
+ 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()
*/
/*!
@@ -172,7 +174,7 @@ int QModbusClient::timeout() const
Already active/running timeouts are not affected by such timeout duration
changes.
- \sa timeout
+ \sa timeout timeoutChanged()
*/
void QModbusClient::setTimeout(int newTimeout)
{