diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-11-09 17:55:40 +0100 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2019-11-14 12:42:51 +0100 |
| commit | 419455bfe6e51601504d7c2fa5a2a9dff9c20851 (patch) | |
| tree | bc1d6f7ae3d5c606d43bac1054c6618d709b6488 /src/remoteobjects/qremoteobjectpendingcall.cpp | |
| parent | f9bf92a6e8e552885bcb2e5f05579a5e224252ae (diff) | |
Doc: Fix documentation warningsv5.14.0-rc1
Fix missing return value and parameter documentation, and do other
minor touch-ups.
Fixes: QTBUG-79818
Change-Id: Ic5c818ea68b8d57846133a1236f82e2a1a10b135
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/remoteobjects/qremoteobjectpendingcall.cpp')
| -rw-r--r-- | src/remoteobjects/qremoteobjectpendingcall.cpp | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/remoteobjects/qremoteobjectpendingcall.cpp b/src/remoteobjects/qremoteobjectpendingcall.cpp index c7574cf..e94c191 100644 --- a/src/remoteobjects/qremoteobjectpendingcall.cpp +++ b/src/remoteobjects/qremoteobjectpendingcall.cpp @@ -157,6 +157,8 @@ bool QRemoteObjectPendingCall::isFinished() const /*! Blocks for up to \a timeout milliseconds, until the remote call has finished. + + Returns \c true on success, \c false otherwise. */ bool QRemoteObjectPendingCall::waitForFinished(int timeout) { @@ -248,7 +250,8 @@ void QRemoteObjectPendingCallWatcher::waitForFinished() /*! \fn QRemoteObjectPendingCallWatcher::finished(QRemoteObjectPendingCallWatcher *self) - This signal is emitted when the remote call has finished. A finished call will include a + This signal is emitted when the remote call has finished. \a self is the pointer to + the watcher object that emitted the signal. A finished call will include a returnValue or error. */ |