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/QXmppCallManager.cpp | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'source/QXmppCallManager.cpp')

diff --git a/source/QXmppCallManager.cpp b/source/QXmppCallManager.cpp
index 09c49d43..3dbd56c3 100644
--- a/source/QXmppCallManager.cpp
+++ b/source/QXmppCallManager.cpp
@@ -102,6 +102,9 @@ void QXmppCall::accept()
         setState(QXmppCall::ConnectingState);
 }
 
+/// Returns the number of bytes that are available for reading.
+///
+
 qint64 QXmppCall::bytesAvailable() const
 {
     return m_incomingBuffer.size();
@@ -149,6 +152,9 @@ void QXmppCall::emitSignals()
     m_signalsEmitted = false;
 }
 
+/// Hangs up the call.
+///
+
 void QXmppCall::hangup()
 {
     if (m_state != QXmppCall::FinishedState)
@@ -160,6 +166,9 @@ bool QXmppCall::isSequential() const
     return true;
 }
 
+/// Returns the remote party's JID.
+///
+
 QString QXmppCall::jid() const
 {
     return m_jid;
@@ -330,13 +339,18 @@ void QXmppCall::datagramReceived(const QByteArray &buffer)
     emit readyRead();
 }
 
-/// Returns the session identifier for this call.
+/// Returns the call's session identifier.
+///
 
 QString QXmppCall::sid() const
 {
     return m_sid;
 }
 
+/// Returns the call's state.
+///
+/// \sa stateChanged()
+
 QXmppCall::State QXmppCall::state() const
 {
     return m_state;
-- 
cgit v1.2.3