From 11e2742230c8fcb5f642b45ca5d5e050d61382ad Mon Sep 17 00:00:00 2001
From: Jeremy Lainé <jeremy.laine@m4x.org>
Date: Fri, 10 Dec 2010 09:55:39 +0000
Subject: improve QXmppDataForm documentation

---
 src/QXmppDataForm.h | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

(limited to 'src/QXmppDataForm.h')

diff --git a/src/QXmppDataForm.h b/src/QXmppDataForm.h
index f4abdb91..2d997846 100644
--- a/src/QXmppDataForm.h
+++ b/src/QXmppDataForm.h
@@ -38,9 +38,14 @@ class QDomElement;
 class QXmppDataForm
 {
 public:
+    /// \brief The QxmppDataForm::Field class represents a data form field
+    /// as defined by XEP-0004: Data Forms.
+    ///
+
     class Field
     {
     public:
+        /// This enum is used to describe a field's type.
         enum Type
         {
             BooleanField,
@@ -88,13 +93,19 @@ public:
         QVariant m_value;
     };
 
+    /// This enum is used to describe a form's type.
     enum Type
     {
-        None,
-        Form,
-        Submit,
-        Cancel,
-        Result,
+        None,   ///< Unknown form type
+        Form,   ///< The form-processing entity is asking the form-submitting
+                ///< entity to complete a form.
+        Submit, ///< The form-submitting entity is submitting data to the
+                ///< form-processing entity.
+        Cancel, ///< The form-submitting entity has cancelled submission
+                ///< of data to the form-processing entity.
+        Result, ///< The form-processing entity is returning data
+                ///< (e.g., search results) to the form-submitting entity,
+                ///< or the data is a generic data set.
     };
 
     QXmppDataForm(QXmppDataForm::Type type = QXmppDataForm::None);
@@ -114,8 +125,10 @@ public:
 
     bool isNull() const;
 
+    /// \cond
     void parse(const QDomElement &element);
     void toXml(QXmlStreamWriter *writer) const;
+    /// \endcond
 
 private:
     QString m_instructions;
-- 
cgit v1.2.3