[Telepathy-commits] [telepathy-qt4/master] Comment explaining the ReferencedHandles API's relation to QList's

[Olli Salli]

---
 TelepathyQt4/cli-referenced-handles.h |    7 +++++++
 1 files changed, 7 insertions(+), 0 deletions(-)

diff --git a/TelepathyQt4/cli-referenced-handles.h b/TelepathyQt4/cli-referenced-handles.h
index c9c80e6..2c3d66b 100644
--- a/TelepathyQt4/cli-referenced-handles.h
+++ b/TelepathyQt4/cli-referenced-handles.h
@@ -70,6 +70,13 @@ namespace Client
  * ReferencedHandles container is guaranteed to be valid (and stay valid, as
  * long it's in at least one ReferencedHandles container).
  *
+ * The class offers a QList-style API. However, from the mutable operations,
+ * only the operations for which the validity guarantees can be preserved are
+ * provided. This means no functions which can add an arbitrary handle to the
+ * container are included - the only way to add handles to the container is to
+ * reference them using Connection::referenceHandles() and appending the
+ * resulting ReferenceHandles instance.
+ *
  * ReferencedHandles is a implicitly shared class.
  */
 class ReferencedHandles
-- 
1.5.6.5