From 9c08abcff13bb568aa0825b67ac0cdf66b756798 Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Sun, 18 Jul 2010 12:06:08 +0000
Subject: improve code documentation

---
 source/QXmppTransferManager.cpp | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

(limited to 'source/QXmppTransferManager.cpp')

diff --git a/source/QXmppTransferManager.cpp b/source/QXmppTransferManager.cpp
index cfc4a491..7f5a47b2 100644
--- a/source/QXmppTransferManager.cpp
+++ b/source/QXmppTransferManager.cpp
@@ -172,7 +172,7 @@ QXmppTransferJob::Direction QXmppTransferJob::direction() const
     return m_direction;
 }
 
-/// Returns the last error that was encoutered.
+/// Returns the last error that was encountered.
 ///
 
 QXmppTransferJob::Error QXmppTransferJob::error() const
@@ -180,11 +180,17 @@ QXmppTransferJob::Error QXmppTransferJob::error() const
     return m_error;
 }
 
+/// Returns the remote party's JID.
+///
+
 QString QXmppTransferJob::jid() const
 {
     return m_jid;
 }
 
+/// Returns meta-data about the file being transfered.
+///
+
 QXmppTransferFileInfo QXmppTransferJob::fileInfo() const
 {
     return m_fileInfo;
@@ -210,16 +216,25 @@ qint64 QXmppTransferJob::fileSize() const
     return m_fileInfo.size();
 }
 
+/// Returns the job's transfer method.
+///
+
 QXmppTransferJob::Method QXmppTransferJob::method() const
 {
     return m_method;
 }
 
+/// Returns the job's session identifier.
+///
+
 QString QXmppTransferJob::sid() const
 {
     return m_sid;
 }
 
+/// Returns the job's state.
+///
+
 QXmppTransferJob::State QXmppTransferJob::state() const
 {
     return m_state;
-- 
cgit v1.2.3