From 393485594b2bb7ab3a7ddc7e49c8cae1105bf77e Mon Sep 17 00:00:00 2001
From: Kitsune Ral <Kitsune-Ral@users.sf.net>
Date: Wed, 12 Dec 2018 13:37:50 +0900
Subject: Room: more doc-comments
---
lib/room.h | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/lib/room.h b/lib/room.h
index ba1eaa48..f7eb224e 100644
--- a/lib/room.h
+++ b/lib/room.h
@@ -437,6 +437,13 @@ namespace QMatrixClient
void userRemoved(User* user);
void memberAboutToRename(User* user, QString newName);
void memberRenamed(User* user);
+ /// The list of members has changed
+ /** Emitted no more than once per sync, this is a good signal to
+ * for cases when some action should be done upon any change in
+ * the member list. If you need per-item granularity you should use
+ * userAdded, userRemoved and memberAboutToRename / memberRenamed
+ * instead.
+ */
void memberListChanged();
/// The previously lazy-loaded members list is now loaded entirely
/// \sa setDisplayed
--
cgit v1.2.3