[Telepathy-commits] [telepathy-qt4/master] Update Account::isValid/isEnabled docs.

Andre Moreira Magalhaes (andrunko) andre.magalhaes at collabora.co.uk
Tue Jan 13 13:27:04 PST 2009


---
 TelepathyQt4/Client/account.cpp |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/TelepathyQt4/Client/account.cpp b/TelepathyQt4/Client/account.cpp
index 04f161a..476e56e 100644
--- a/TelepathyQt4/Client/account.cpp
+++ b/TelepathyQt4/Client/account.cpp
@@ -212,6 +212,11 @@ AccountManager *Account::manager() const
 /**
  * Get whether this is a valid account.
  *
+ * If true, this account is considered by the account manager to be complete
+ * and usable. If false, user action is required to make it usable, and it will
+ * never attempt to connect (for instance, this might be caused by the absence
+ * of a required parameter).
+ *
  * \return \c true if the account is valid, \c false otherwise.
  */
 bool Account::isValid() const
@@ -222,6 +227,9 @@ bool Account::isValid() const
 /**
  * Get whether this account is enabled.
  *
+ * Gives the users the possibility to prevent an account from
+ * being used. This flag does not change the validity of the account.
+ *
  * \return \c true if the account is enabled, \c false otherwise.
  */
 bool Account::isEnabled() const
-- 
1.5.6.5




More information about the Telepathy-commits mailing list