From ac1831936f7858d7f2197ef11dff226ce08d5bb1 Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Sat, 6 Mar 2010 14:06:29 +0000
Subject: improve code documentation

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

(limited to 'source/QXmppTransferManager.cpp')

diff --git a/source/QXmppTransferManager.cpp b/source/QXmppTransferManager.cpp
index 93b3634e..8b32f732 100644
--- a/source/QXmppTransferManager.cpp
+++ b/source/QXmppTransferManager.cpp
@@ -95,7 +95,7 @@ void QXmppTransferJob::checkData()
 
 /// Returns the job's data for a given role.
 ///
-/// You can associate arbitrary data with the role using setData.
+/// You can associate arbitrary data with the role using setData().
 
 QVariant QXmppTransferJob::data(int role) const
 {
@@ -112,11 +112,17 @@ void QXmppTransferJob::setData(int role, const QVariant &value)
     m_data.insert(role, value);
 }
 
+/// Returns the job's transfer direction.
+///
+
 QXmppTransferJob::Direction QXmppTransferJob::direction() const
 {
     return m_direction;
 }
 
+/// Returns the last error that was encoutered.
+///
+
 QXmppTransferJob::Error QXmppTransferJob::error() const
 {
     return m_error;
@@ -702,6 +708,10 @@ void QXmppTransferManager::jobStateChanged(QXmppTransferJob::State state)
     m_client->sendPacket(response);
 }
 
+/// Send file to a remote party.
+///
+/// The remote party will be given the choice to accept or refuse the transfer.
+///
 QXmppTransferJob *QXmppTransferManager::sendFile(const QString &jid, const QString &fileName)
 {
     QFileInfo info(fileName);
@@ -1130,6 +1140,8 @@ void QXmppTransferManager::setProxy(const QString &proxyJid)
 
 /// Return the supported stream methods.
 ///
+/// The methods are a combination of zero or more QXmppTransferJob::Method.
+///
 
 int QXmppTransferManager::supportedMethods() const
 {
-- 
cgit v1.2.3