[Telepathy-commits] [telepathy-qt4/master] Channel docs: improve English and be consistent about param naming

Simon McVittie simon.mcvittie at collabora.co.uk
Tue Feb 24 03:05:22 PST 2009


---
 TelepathyQt4/Client/channel.cpp |   10 ++++++----
 1 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/TelepathyQt4/Client/channel.cpp b/TelepathyQt4/Client/channel.cpp
index 37f48a6..664d107 100644
--- a/TelepathyQt4/Client/channel.cpp
+++ b/TelepathyQt4/Client/channel.cpp
@@ -1107,8 +1107,9 @@ QSharedPointer<Contact> Channel::initiatorContact() const
  * until the object is ready. To wait for the object to be ready, call
  * becomeReady() and connect to the finished signal on the result.
  *
- * \param features Which features should be tested.
- * \return \c true if the object has finished initial setup.
+ * \param features The features which should be tested
+ * \return \c true if the object has finished its initial setup for basic
+ *         functionality plus the given features
  */
 bool Channel::isReady(Features features) const
 {
@@ -1121,9 +1122,10 @@ bool Channel::isReady(Features features) const
  * its initial setup, or will fail if a fatal error occurs during this
  * initial setup.
  *
- * \param features Which features should be tested.
+ * \param requestedFeatures The features which should be enabled
  * \return A PendingReadyChannel object which will emit finished
- *         when this object has finished or failed its initial setup.
+ *         when this object has finished or failed initial setup for basic
+ *         functionality plus the given features
  */
 PendingReadyChannel *Channel::becomeReady(Features requestedFeatures)
 {
-- 
1.5.6.5




More information about the telepathy-commits mailing list