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>

3 files changed, 13 insertions, 7 deletions

diff --git a/src/remoteobjects/doc/src/remoteobjects-qml.qdoc b/src/remoteobjects/doc/src/remoteobjects-qml.qdoc
index e69c9be..340dec9 100644
--- a/src/remoteobjects/doc/src/remoteobjects-qml.qdoc
+++ b/src/remoteobjects/doc/src/remoteobjects-qml.qdoc
@@ -95,7 +95,8 @@ import QtRemoteObjects 5.\1
 
 /*!
     \qmlmethod Promise QtRemoteObjects::QtRemoteObjects::watch(QRemoteObjectPendingCall reply, int timeout = 30000)
-    Encapsulates the return value from a replica in a JavaScript Promise.
+    Encapsulates the return value, represented by \a reply, from a replica in a JavaScript Promise.
+    A timeout can be set with \e timeout. The default timeout value is 30 seconds.
 
     \qml
     QtRemoteObjects.watch(replica.fetchDetails(identifier))
diff --git a/src/remoteobjects/qremoteobjectnode.cpp b/src/remoteobjects/qremoteobjectnode.cpp
index 35e36ec..c2fba06 100644
--- a/src/remoteobjects/qremoteobjectnode.cpp
+++ b/src/remoteobjects/qremoteobjectnode.cpp
@@ -421,7 +421,7 @@ bool QRemoteObjectHostBase::proxy(const QUrl &registryUrl, const QUrl &hostUrl,
 
 /*!
     \since 5.11
-    \brief Forward Remote Objects to another network
+    \brief Forwards remote objects to another network.
 
     The reverseProxy() function allows the \l proxy() functionality to be
     extended, in effect mirroring the proxy functionality in the "reverse"
@@ -478,6 +478,8 @@ bool QRemoteObjectHostBase::proxy(const QUrl &registryUrl, const QUrl &hostUrl,
     objects on proxyNode and acquire them on the internal node if they pass the
     reverseFilter.
 
+    Returns \c true on success, \c false otherwise.
+
     \sa proxy()
 */
 bool QRemoteObjectHostBase::reverseProxy(QRemoteObjectHostBase::RemoteObjectNameFilter filter)
@@ -1816,7 +1818,7 @@ bool QRemoteObjectHostBase::setHostUrl(const QUrl &hostAddress, AllowedSchemas a
 
 /*!
     Returns the host address for the QRemoteObjectNode as a QUrl. If the Node
-    is not a Host node, it return an empty QUrl.
+    is not a Host node, returns an empty QUrl.
 
     \sa setHostUrl()
 */
@@ -2097,7 +2099,7 @@ void QRemoteObjectNode::addClientSideConnection(QIODevice *ioDevice)
 */
 
 /*!
-    \fn void remoteObjectRemoved(const QRemoteObjectSourceLocation &loc)
+    \fn void QRemoteObjectNode::remoteObjectRemoved(const QRemoteObjectSourceLocation &loc)
 
     This signal is emitted whenever there is a known \l {Source} object is
     removed from the Registry. The signal will not be emitted if there is no
@@ -2335,8 +2337,8 @@ void QRemoteObjectHostBase::addHostSideConnection(QIODevice *ioDevice)
 /*!
  Returns a pointer to a Replica which is specifically derived from \l
  QAbstractItemModel. The \a name provided must match the name used with the
- matching \l {QRemoteObjectHostBase::enableRemoting} {enableRemoting} that put
- the Model on the network. The returned \c model will be empty until it is
+ matching \l {QRemoteObjectHostBase::}{enableRemoting} that put
+ the Model on the network. The returned model will be empty until it is
  initialized with the \l Source.
  */
 QAbstractItemModelReplica *QRemoteObjectNode::acquireModel(const QString &name, QtRemoteObjects::InitialAction action, const QVector<int> &rolesHint)
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.
 */