Improve the documentation and fix warnings

Change-Id: I9b26337ba976079608ece4781999ad0ef49a4f19
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Edward Welbourne <edward.welbourne@qt.io>
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>

1 files changed, 37 insertions, 2 deletions

diff --git a/src/coap/qcoapprotocol.cpp b/src/coap/qcoapprotocol.cpp
index d78baf1..fc5e4eb 100644
--- a/src/coap/qcoapprotocol.cpp
+++ b/src/coap/qcoapprotocol.cpp
@@ -41,6 +41,8 @@ QT_BEGIN_NAMESPACE
 
 /*!
     \class QCoapProtocol
+    \inmodule QtCoap
+
     \brief The QCoapProtocol class handles the logical part of the CoAP
     protocol.
 
@@ -55,6 +57,38 @@ QT_BEGIN_NAMESPACE
 */
 
 /*!
+    \fn void QCoapProtocol::finished(QCoapReply *reply)
+
+    This signal is emitted along with the \l QCoapReply::finished() signal
+    whenever a CoAP reply is received, after either a success or an error.
+    The \a reply parameter will contain a pointer to the reply that has just
+    been received.
+
+    \sa error(), QCoapReply::finished(), QCoapReply::error()
+*/
+
+/*!
+    \fn void QCoapProtocol::responseToMulticastReceived(QCoapReply *reply,
+                                                        const QCoapMessage& message)
+
+    This signal is emitted when a unicast response to a multicast request
+    arrives. The \a reply parameter contains a pointer to the reply that has just
+    been received, and \a message contains the payload and the message details.
+
+    \sa error(), QCoapReply::finished(), QCoapReply::error()
+*/
+
+/*!
+    \fn void QCoapProtocol::error(QCoapReply *reply, QtCoap::Error error)
+
+    This signal is emitted whenever an error occurs. The \a reply parameter
+    can be \nullptr if the error is not related to a specific QCoapReply. The
+    \a error parameter contains the error code.
+
+    \sa finished(), QCoapReply::error(), QCoapReply::finished()
+*/
+
+/*!
     Constructs a new QCoapProtocol and sets \a parent as the parent object.
 */
 QCoapProtocol::QCoapProtocol(QObject *parent) :
@@ -706,8 +740,9 @@ void QCoapProtocolPrivate::onConnectionError(QAbstractSocket::SocketError socket
 }
 
 /*!
-    Decodes the \a data to a list of QCoapResource objects.
-    The \a data byte array is a frame returned by a discovery request.
+    Decodes the \a data received from the \a sender to a list of QCoapResource
+    objects. The \a data byte array contains the frame returned by the
+    discovery request.
 */
 QVector<QCoapResource> QCoapProtocol::resourcesFromCoreLinkList(const QHostAddress &sender,
                                                                 const QByteArray &data)