From 10a3962269971b60a21b50e6615c61d890b4f5f3 Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Sun, 22 Jul 2012 10:33:07 +0200
Subject: improve RSM documentation

---
 src/base/QXmppResultSet.cpp | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

(limited to 'src/base/QXmppResultSet.cpp')

diff --git a/src/base/QXmppResultSet.cpp b/src/base/QXmppResultSet.cpp
index 7589b62a..911bc196 100644
--- a/src/base/QXmppResultSet.cpp
+++ b/src/base/QXmppResultSet.cpp
@@ -47,8 +47,6 @@ int QXmppResultSetQuery::max() const
 /// Sets the maximum number of results.
 ///
 /// \note -1 means no limit, 0 means no results are wanted.
-///
-/// \param max
 
 void QXmppResultSetQuery::setMax(int max)
 {
@@ -154,35 +152,35 @@ QXmppResultSetReply::QXmppResultSetReply()
     , m_index(-1)
 {}
 
-/// Returns the UID of the first result in the set.
+/// Returns the UID of the first result in the page.
 
 QString QXmppResultSetReply::first() const
 {
     return m_first;
 }
 
-/// Sets the UID of the first result in the set.
+/// Sets the UID of the first result in the page.
 
 void QXmppResultSetReply::setFirst(const QString& first)
 {
     m_first=first;
 }
 
-/// Returns the UID of the last result in the set.
+/// Returns the UID of the last result in the page.
 
 QString QXmppResultSetReply::last() const
 {
     return m_last;
 }
 
-/// Sets the UID of the last result in the set.
+/// Sets the UID of the last result in the page.
 
 void QXmppResultSetReply::setLast(const QString& last)
 {
     m_last=last;
 }
 
-/// Returns the number of items in the set.
+/// Returns the total number of items in the set.
 ///
 /// \note This may be an approximate count.
 
@@ -191,7 +189,7 @@ int QXmppResultSetReply::count() const
     return m_count;
 }
 
-/// Sets the number of items in the set.
+/// Sets the total number of items in the set.
 ///
 /// \note This may be an approximate count.
 
@@ -200,18 +198,22 @@ void QXmppResultSetReply::setCount(int count)
     m_count = count;
 }
 
-/// Returns the index for the first result in the set.
+/// Returns the index for the first result in the page.
 ///
 /// This is used for retrieving pages out of order.
+///
+/// \note This may be an approximate index.
 
 int QXmppResultSetReply::index() const
 {
     return m_index;
 }
 
-/// Sets the index for the first result in the set.
+/// Sets the index for the first result in the page.
 ///
 /// This is used for retrieving pages out of order.
+///
+/// \note This may be an approximate index.
 
 void QXmppResultSetReply::setIndex(int index)
 {
-- 
cgit v1.2.3