From 9c08abcff13bb568aa0825b67ac0cdf66b756798 Mon Sep 17 00:00:00 2001 From: Jeremy Lainé Date: Sun, 18 Jul 2010 12:06:08 +0000 Subject: improve code documentation --- source/QXmppCallManager.h | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'source/QXmppCallManager.h') 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; -- cgit v1.2.3