From 4392a229eb8a53b5903b0df8779ed8f1a6ee0f06 Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Mon, 31 Aug 2015 17:53:42 +0200
Subject: add some code docs

---
 src/base/QXmppJingleIq.cpp | 9 ++++++++-
 src/base/QXmppJingleIq.h   | 1 +
 2 files changed, 9 insertions(+), 1 deletion(-)

(limited to 'src/base')

diff --git a/src/base/QXmppJingleIq.cpp b/src/base/QXmppJingleIq.cpp
index 89750a42..94207a38 100644
--- a/src/base/QXmppJingleIq.cpp
+++ b/src/base/QXmppJingleIq.cpp
@@ -619,7 +619,6 @@ QString QXmppJingleIq::Content::toSdp() const
     return sdp.join("\r\n") + "\r\n";
 }
 
-
 /// \endcond
 
 QXmppJingleIq::Reason::Reason()
@@ -627,21 +626,29 @@ QXmppJingleIq::Reason::Reason()
 {
 }
 
+/// Returns the reason's textual description.
+
 QString QXmppJingleIq::Reason::text() const
 {
     return m_text;
 }
 
+/// Sets the reason's textual description.
+
 void QXmppJingleIq::Reason::setText(const QString &text)
 {
     m_text = text;
 }
 
+/// Gets the reason's type.
+
 QXmppJingleIq::Reason::Type QXmppJingleIq::Reason::type() const
 {
     return m_type;
 }
 
+/// Sets the reason's type.
+
 void QXmppJingleIq::Reason::setType(QXmppJingleIq::Reason::Type type)
 {
     m_type = type;
diff --git a/src/base/QXmppJingleIq.h b/src/base/QXmppJingleIq.h
index 4c14a8a9..e997bef4 100644
--- a/src/base/QXmppJingleIq.h
+++ b/src/base/QXmppJingleIq.h
@@ -249,6 +249,7 @@ public:
     class QXMPP_EXPORT Reason
     {
     public:
+        /// This enum is used to describe a reason's type.
         enum Type {
             None,
             AlternativeSession,
-- 
cgit v1.2.3