summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndre Moreira Magalhaes (andrunko) <andre.magalhaes@collabora.co.uk>2009-07-23 21:40:53 (GMT)
committerAndre Moreira Magalhaes (andrunko) <andre.magalhaes@collabora.co.uk>2009-07-23 21:41:28 (GMT)
commitc3aa1c091be90085ab1cb3a532be3b219b1c3a14 (patch)
tree475c2913a3f9430cb621897049d9ef30f47b820c
parentcb6c27c256c85d019ca22b236681a8867c4c4cd6 (diff)
parentcb6d8a6c408216003013defec8f7e749aaec6e98 (diff)
downloadtelepathy-qt4-c3aa1c091be90085ab1cb3a532be3b219b1c3a14.tar.gz
telepathy-qt4-c3aa1c091be90085ab1cb3a532be3b219b1c3a14.tar.xz
Merge commit 'gberg/doc-fixes'
Reviewed-by: Simon McVittie (smcv) <simon.mcvittie@collabora.co.uk>
-rw-r--r--TelepathyQt4/account.cpp23
1 files changed, 13 insertions, 10 deletions
diff --git a/TelepathyQt4/account.cpp b/TelepathyQt4/account.cpp
index 5917ab2..9f1fa2f 100644
--- a/TelepathyQt4/account.cpp
+++ b/TelepathyQt4/account.cpp
@@ -537,7 +537,7 @@ ConnectionStatusReason Account::connectionStatusReason() const
}
/**
- * Return whether this account have a connection object that can be retrieved
+ * Return whether this account has a connection object that can be retrieved
* using connection().
*
* \return \c true if a connection object can be retrieved, \c false otherwise
@@ -550,13 +550,14 @@ bool Account::haveConnection() const
/**
* Get the Connection object for this account.
*
- * Note that the Connection object won't be cached by account, and
- * should be done by the application itself.
+ * The Connection object will not be cached by the Account instance;
+ * applications should do this themselves.
*
- * Remember to call Connection::becomeReady on the new connection, to
+ * Remember to call Connection::becomeReady on the new connection to
* make sure it is ready before using it.
*
- * \return Connection object, or 0 if an error occurred.
+ * \return Connection object, or a null ConnectionPtr if the account does
+ * not currently have a Connection or if an error occurred.
*/
ConnectionPtr Account::connection() const
{
@@ -573,10 +574,11 @@ ConnectionPtr Account::connection() const
}
/**
- * Set the presence status that this account should have if it is brought
- * online.
+ * Get the presence status that this account will have set on it by the account
+ * manager if it brings it online automatically.
*
- * \return Presence status that will be set when this account is put online.
+ * \return Presence status that will be set by the account manager if this
+ * account is brought online automatically by it.
*/
SimplePresence Account::automaticPresence() const
{
@@ -585,9 +587,10 @@ SimplePresence Account::automaticPresence() const
/**
* Set the presence status that this account should have if it is brought
- * online.
+ * online automatically by the account manager.
*
- * \param value Presence status to set when this account is put online.
+ * \param value Presence status to set when this account is brought online
+ * automatically by the account manager.
* \return A PendingOperation which will emit PendingOperation::finished
* when the call has finished.
* \sa setRequestedPresence()