From 6f701abe515c0d04d712a69e4883ce92ce6517b5 Mon Sep 17 00:00:00 2001 From: Jeremy Lainé Date: Mon, 13 Jun 2011 19:56:14 +0000 Subject: add documentation for State enum --- src/QXmppClient.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'src') 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); -- cgit v1.2.3