add documentation for State enum

1 files changed, 4 insertions, 3 deletions

diff --git a/src/QXmppClient.h b/src/QXmppClient.h
index 4ce27abb..490351d9 100644
--- a/src/QXmppClient.h
+++ b/src/QXmppClient.h
@@ -93,11 +93,12 @@ public:
         XmppStreamError,    ///< Error due to XML stream
     };
 
+    /// This enumeration describes a client state.
     enum State
     {
-        DisconnectedState,
-        ConnectingState,
-        ConnectedState,
+        DisconnectedState,  ///< Disconnected from the server.
+        ConnectingState,    ///< Trying to connect to the server.
+        ConnectedState,     ///< Connected to the server.
     };
 
     QXmppClient(QObject *parent = 0);