doc fixes

4 files changed, 41 insertions, 9 deletions

diff --git a/src/base/QXmppArchiveIq.cpp b/src/base/QXmppArchiveIq.cpp
index e162a146..bfc7ba05 100644
--- a/src/base/QXmppArchiveIq.cpp
+++ b/src/base/QXmppArchiveIq.cpp
@@ -235,11 +235,19 @@ void QXmppArchiveChatIq::setChat(const QXmppArchiveChat &chat)
     m_chat = chat;
 }
 
+/// Returns the result set management reply.
+///
+/// This is used for paging through messages.
+
 QXmppResultSetReply QXmppArchiveChatIq::resultSetReply() const
 {
     return m_rsmReply;
 }
 
+/// Sets the result set management reply.
+///
+/// This is used for paging through messages.
+
 void QXmppArchiveChatIq::setResultSetReply(const QXmppResultSetReply& rsm)
 {
     m_rsmReply = rsm;
@@ -336,21 +344,37 @@ void QXmppArchiveListIq::setEnd(const QDateTime &end)
     m_end = end;
 }
 
+/// Returns the result set management query.
+///
+/// This is used for paging through conversations.
+
 QXmppResultSetQuery QXmppArchiveListIq::resultSetQuery() const
 {
     return m_rsmQuery;
 }
 
+/// Sets the result set management query.
+///
+/// This is used for paging through conversations.
+
 void QXmppArchiveListIq::setResultSetQuery(const QXmppResultSetQuery& rsm)
 {
     m_rsmQuery = rsm;
 }
 
+/// Returns the result set management reply.
+///
+/// This is used for paging through conversations.
+
 QXmppResultSetReply QXmppArchiveListIq::resultSetReply() const
 {
     return m_rsmReply;
 }
 
+/// Sets the result set management reply.
+///
+/// This is used for paging through conversations.
+
 void QXmppArchiveListIq::setResultSetReply(const QXmppResultSetReply& rsm)
 {
     m_rsmReply = rsm;
@@ -540,11 +564,19 @@ void QXmppArchiveRetrieveIq::setWith(const QString &with)
     m_with = with;
 }
 
+/// Returns the result set management query.
+///
+/// This is used for paging through messages.
+
 QXmppResultSetQuery QXmppArchiveRetrieveIq::resultSetQuery() const
 {
     return m_rsmQuery;
 }
 
+/// Sets the result set management query.
+///
+/// This is used for paging through messages.
+
 void QXmppArchiveRetrieveIq::setResultSetQuery(const QXmppResultSetQuery& rsm)
 {
     m_rsmQuery = rsm;
diff --git a/src/base/QXmppArchiveIq.h b/src/base/QXmppArchiveIq.h
index 9761039c..b4663fdd 100644
--- a/src/base/QXmppArchiveIq.h
+++ b/src/base/QXmppArchiveIq.h
@@ -112,10 +112,8 @@ public:
 
     /// \cond
     static bool isArchiveChatIq(const QDomElement &element);
-    /// \endcond
 
 protected:
-    /// \cond
     void parseElementFromChild(const QDomElement &element);
     void toXmlElementFromChild(QXmlStreamWriter *writer) const;
     /// \endcond
@@ -189,10 +187,8 @@ public:
 
     /// \cond
     static bool isArchiveRemoveIq(const QDomElement &element);
-    /// \endcond
 
 protected:
-    /// \cond
     void parseElementFromChild(const QDomElement &element);
     void toXmlElementFromChild(QXmlStreamWriter *writer) const;
     /// \endcond
@@ -223,10 +219,8 @@ public:
 
     /// \cond
     static bool isArchiveRetrieveIq(const QDomElement &element);
-    /// \endcond
 
 protected:
-    /// \cond
     void parseElementFromChild(const QDomElement &element);
     void toXmlElementFromChild(QXmlStreamWriter *writer) const;
     /// \endcond
@@ -246,10 +240,8 @@ class QXMPP_EXPORT QXmppArchivePrefIq : public QXmppIq
 public:
     /// \cond
     static bool isArchivePrefIq(const QDomElement &element);
-    /// \endcond
 
 protected:
-    /// \cond
     void parseElementFromChild(const QDomElement &element);
     void toXmlElementFromChild(QXmlStreamWriter *writer) const;
     /// \endcond
diff --git a/src/base/QXmppPresence.cpp b/src/base/QXmppPresence.cpp
index ee07d47f..cfe416b5 100644
--- a/src/base/QXmppPresence.cpp
+++ b/src/base/QXmppPresence.cpp
@@ -95,7 +95,7 @@ QString QXmppPresence::statusText() const
 
 /// Sets the status text, a textual description of the user's status.
 ///
-/// \param str The status text, for example "Gone fishing".
+/// \param statusText The status text, for example "Gone fishing".
 
 void QXmppPresence::setStatusText(const QString& statusText)
 {
diff --git a/src/base/QXmppResultSet.cpp b/src/base/QXmppResultSet.cpp
index 2f401803..25b1e9b6 100644
--- a/src/base/QXmppResultSet.cpp
+++ b/src/base/QXmppResultSet.cpp
@@ -55,11 +55,19 @@ void QXmppResultSetQuery::setMax(int max)
     m_max = max;
 }
 
+/// Returns the index for the first element in the page.
+///
+/// This is used for retrieving pages out of order.
+
 int QXmppResultSetQuery::index() const
 {
     return m_index;
 }
 
+/// Sets the index for the first element in the page.
+///
+/// This is used for retrieving pages out of order.
+
 void QXmppResultSetQuery::setIndex(int index)
 {
     m_index=index;