improve documentation

4 files changed, 31 insertions, 4 deletions

diff --git a/src/QXmppDialback.cpp b/src/QXmppDialback.cpp
index b62fba90..0dbb4212 100644
--- a/src/QXmppDialback.cpp
+++ b/src/QXmppDialback.cpp
@@ -27,37 +27,56 @@
 #include "QXmppDialback.h"
 #include "QXmppUtils.h"
 
+/// Constructs a QXmppDialback.
+
 QXmppDialback::QXmppDialback()
     : m_command(Result)
 {
 }
 
+/// Returns the dialback command.
+
 QXmppDialback::Command QXmppDialback::command() const
 {
     return m_command;
 }
 
+/// Sets the dialback command.
+///
+/// \param command
+
 void QXmppDialback::setCommand(QXmppDialback::Command command)
 {
     m_command = command;
 }
 
+/// Returns the dialback key.
 
 QString QXmppDialback::key() const
 {
     return m_key;
 }
 
+/// Sets the dialback key.
+///
+/// \param key
+
 void QXmppDialback::setKey(const QString &key)
 {
     m_key = key;
 }
 
+/// Returns the dialback type.
+
 QString QXmppDialback::type() const
 {
     return m_type;
 }
 
+/// Sets the dialback type.
+///
+/// \param type
+
 void QXmppDialback::setType(const QString &type)
 {
     m_type = type;
diff --git a/src/QXmppDialback.h b/src/QXmppDialback.h
index 183c3913..8fb0bde6 100644
--- a/src/QXmppDialback.h
+++ b/src/QXmppDialback.h
@@ -34,9 +34,12 @@
 class QXmppDialback : public QXmppStanza
 {
 public:
+    /// This enum is used to describe a dialback command.
     enum Command {
-        Result,
-        Verify,
+        Result, ///< A dialback command between the originating server
+                ///< and the receiving server.
+        Verify, ///< A dialback command between the receiving server
+                ///< and the authoritative server.
     };
 
     QXmppDialback();
@@ -53,9 +56,9 @@ public:
     /// \cond
     void parse(const QDomElement &element);
     void toXml(QXmlStreamWriter *writer) const;
-    /// \endcond
 
     static bool isDialback(const QDomElement &element);
+    /// \endcond
 
 private:
     Command m_command;
diff --git a/src/QXmppIq.cpp b/src/QXmppIq.cpp
index e3725d61..6f4c8203 100644
--- a/src/QXmppIq.cpp
+++ b/src/QXmppIq.cpp
@@ -28,6 +28,10 @@
 #include <QDomElement>
 #include <QXmlStreamWriter>
 
+/// Constructs a QXmppIq with the specified \a type.
+///
+/// \param type
+
 QXmppIq::QXmppIq(QXmppIq::Type type)
     : QXmppStanza(), m_type(type)
 {
diff --git a/src/QXmppStun.cpp b/src/QXmppStun.cpp
index e7a468d8..2df5b705 100644
--- a/src/QXmppStun.cpp
+++ b/src/QXmppStun.cpp
@@ -1292,13 +1292,14 @@ QList<QHostAddress> QXmppIceComponent::discoverAddresses()
     return addresses;
 }
 
-/// Tries to bind \a count UDP sockets on eich of the given \a addresses.
+/// Tries to bind \a count UDP sockets on each of the given \a addresses.
 ///
 /// The port numbers are chosen so that they are consecutive, starting at
 /// an even port. This makes them suitable for RTP/RTCP sockets pairs.
 ///
 /// \param addresses The network address on which to bind the sockets.
 /// \param count     The number of ports to reserve.
+/// \param parent    The parent object for the sockets.
 
 QList<QUdpSocket*> QXmppIceComponent::reservePorts(const QList<QHostAddress> &addresses, int count, QObject *parent)
 {