improve QXmppBindIq documentation

2 files changed, 25 insertions, 18 deletions

diff --git a/src/QXmppBindIq.cpp b/src/QXmppBindIq.cpp
index 759e9cbf..e3035904 100644
--- a/src/QXmppBindIq.cpp
+++ b/src/QXmppBindIq.cpp
@@ -30,33 +30,38 @@
 #include "QXmppUtils.h"
 #include "QXmppConstants.h"
 
-QXmppBindIq::QXmppBindIq()
-{
-}
+/// Returns the bound JID.
+///
 
-QXmppBindIq::QXmppBindIq(QXmppIq::Type type)
-    : QXmppIq(type)
+QString QXmppBindIq::jid() const
 {
+    return m_jid;
 }
 
-QString QXmppBindIq::jid() const
+/// Sets the bound JID.
+///
+/// \param jid
+
+void QXmppBindIq::setJid(const QString& jid)
 {
-    return m_jid;
+    m_jid = jid;
 }
 
+/// Returns the requested resource.
+///
+
 QString QXmppBindIq::resource() const
 {
     return m_resource;
 }
 
-void QXmppBindIq::setJid(const QString& str)
-{
-    m_jid = str;
-}
+/// Sets the requested resource.
+///
+/// \param resource
 
-void QXmppBindIq::setResource(const QString& str)
+void QXmppBindIq::setResource(const QString& resource)
 {
-    m_resource = str;
+    m_resource = resource;
 }
 
 bool QXmppBindIq::isBindIq(const QDomElement &element)
diff --git a/src/QXmppBindIq.h b/src/QXmppBindIq.h
index 5794c66a..7fb1b66c 100644
--- a/src/QXmppBindIq.h
+++ b/src/QXmppBindIq.h
@@ -28,16 +28,18 @@
 
 #include "QXmppIq.h"
 
+/// \brief The QXmppBindIq class represents an IQ used for resource
+/// binding as defined by RFC 5921.
+///
+/// \ingroup Stanzas
+
 class QXmppBindIq : public QXmppIq
 {
 public:
-    QXmppBindIq();
-    QXmppBindIq(QXmppIq::Type type);
-    
     QString jid() const;
-    QString resource() const;
-
     void setJid(const QString&);
+
+    QString resource() const;
     void setResource(const QString&);
 
     static bool isBindIq(const QDomElement &element);