improve code documentation

1 files changed, 7 insertions, 5 deletions

diff --git a/source/QXmppCallManager.h b/source/QXmppCallManager.h
index a16e3717..ea397ab5 100644
--- a/source/QXmppCallManager.h
+++ b/source/QXmppCallManager.h
@@ -49,19 +49,21 @@ class QXmppCall : public QIODevice
     Q_OBJECT
 
 public:
+    /// This enum is used to describe the direction of a call.
     enum Direction
     {
         IncomingDirection, ///< The call is incoming.
         OutgoingDirection, ///< The call is outgoing.
     };
 
+    /// This enum is used to describe the state of a call.
     enum State
     {
-        OfferState = 0,
-        ConnectingState = 1,
-        ActiveState = 2,
-        DisconnectingState = 3,
-        FinishedState = 4,
+        OfferState = 0,         ///< The remote part is being called.
+        ConnectingState = 1,    ///< The call is being connected.
+        ActiveState = 2,        ///< The call is active.
+        DisconnectingState = 3, ///< The call is being disconnected.
+        FinishedState = 4,      ///< The call is finished.
     };
 
     QXmppCall::Direction direction() const;