From f8253c3f6da17ac20919b7a1e2c4ca7bfdfea5e9 Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Fri, 10 Dec 2010 09:43:05 +0000
Subject: add some documentation for QXmppArchiveIq

---
 src/QXmppArchiveIq.cpp | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

(limited to 'src/QXmppArchiveIq.cpp')

diff --git a/src/QXmppArchiveIq.cpp b/src/QXmppArchiveIq.cpp
index eb4c6ccd..c1b5d62c 100644
--- a/src/QXmppArchiveIq.cpp
+++ b/src/QXmppArchiveIq.cpp
@@ -29,31 +29,48 @@
 static const char *ns_archive = "urn:xmpp:archive";
 static const char *ns_rsm = "http://jabber.org/protocol/rsm";
 
+/// Returns the archived message's body.
+
 QString QXmppArchiveMessage::body() const
 {
     return m_body;
 }
 
+/// Sets the archived message's body.
+///
+/// \param body
 void QXmppArchiveMessage::setBody(const QString &body)
 {
     m_body = body;
 }
 
+/// Returns the archived message's date.
+
 QDateTime QXmppArchiveMessage::date() const
 {
     return m_date;
 }
 
+//// Sets the archived message's date.
+///
+/// \param date
+
 void QXmppArchiveMessage::setDate(const QDateTime &date)
 {
     m_date = date;
 }
 
+/// Returns true if the archived message was received, false if it was sent.
+
 bool QXmppArchiveMessage::isReceived() const
 {
     return m_received;
 }
 
+/// Set to true if the archived message was received, false if it was sent.
+///
+/// \param isReceived
+
 void QXmppArchiveMessage::setReceived(bool isReceived)
 {
     m_received = isReceived;
@@ -100,31 +117,43 @@ void QXmppArchiveChat::toXml(QXmlStreamWriter *writer) const
     writer->writeEndElement();
 }
 
+/// Returns the conversation's messages.
+
 QList<QXmppArchiveMessage> QXmppArchiveChat::messages() const
 {
     return m_messages;
 }
 
+/// Returns the start of this conversation.
+
 QDateTime QXmppArchiveChat::start() const
 {
     return m_start;
 }
 
+/// Returns the conversation's subject.
+
 QString QXmppArchiveChat::subject() const
 {
     return m_subject;
 }
 
+/// Returns the conversation's version.
+
 int QXmppArchiveChat::version() const
 {
     return m_version;
 }
 
+/// Returns the JID of the remote party.
+ 
 QString QXmppArchiveChat::with() const
 {
     return m_with;
 }
 
+/// Returns the chat conversation carried by this IQ.
+
 QXmppArchiveChat QXmppArchiveChatIq::chat() const
 {
     return m_chat;
@@ -147,11 +176,15 @@ void QXmppArchiveChatIq::toXmlElementFromChild(QXmlStreamWriter *writer) const
     m_chat.toXml(writer);
 }
 
+/// Constructs a QXmppArchiveListIq.
+
 QXmppArchiveListIq::QXmppArchiveListIq()
     : QXmppIq(QXmppIq::Get), m_max(0)
 {
 }
 
+/// Returns the list of chat conversations.
+
 QList<QXmppArchiveChat> QXmppArchiveListIq::chats() const
 {
     return m_chats;
-- 
cgit v1.2.3