aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/banning.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-29 22:22:49 +0900
committerKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-29 22:22:49 +0900
commitb55334ac0fe89f780776bc4eab90ffe1ca3c57bb (patch)
tree1a45c0ccfec8f5f7ba37eb4385cdc7f61afa0c97 /lib/csapi/banning.h
parentf5c2e47fa1ab84fdaffe03c30ba973d7dea5ac05 (diff)
parent1e6510790dab6b9141ae52993987b406399668cd (diff)
downloadlibquotient-b55334ac0fe89f780776bc4eab90ffe1ca3c57bb.tar.gz
libquotient-b55334ac0fe89f780776bc4eab90ffe1ca3c57bb.zip
Merge branch 'cs-api-0.4.0'
Diffstat (limited to 'lib/csapi/banning.h')
-rw-r--r--lib/csapi/banning.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/lib/csapi/banning.h b/lib/csapi/banning.h
index 196ddf66..237bd2a0 100644
--- a/lib/csapi/banning.h
+++ b/lib/csapi/banning.h
@@ -12,7 +12,7 @@ namespace QMatrixClient
// Operations
/// Ban a user in the room.
- ///
+ ///
/// Ban a user in the room. If the user is currently in the room, also kick them.
///
/// When a user is banned from a room, they may not join it or be invited to it until they are unbanned.
@@ -22,18 +22,18 @@ namespace QMatrixClient
{
public:
/*! Ban a user in the room.
- * \param roomId
+ * \param roomId
* The room identifier (not alias) from which the user should be banned.
- * \param userId
+ * \param userId
* The fully qualified user ID of the user being banned.
- * \param reason
+ * \param reason
* The reason the user has been banned. This will be supplied as the ``reason`` on the target's updated `m.room.member`_ event.
*/
explicit BanJob(const QString& roomId, const QString& userId, const QString& reason = {});
};
/// Unban a user from the room.
- ///
+ ///
/// Unban a user from the room. This allows them to be invited to the room,
/// and join if they would otherwise be allowed to join according to its join rules.
///
@@ -42,9 +42,9 @@ namespace QMatrixClient
{
public:
/*! Unban a user from the room.
- * \param roomId
+ * \param roomId
* The room identifier (not alias) from which the user should be unbanned.
- * \param userId
+ * \param userId
* The fully qualified user ID of the user being unbanned.
*/
explicit UnbanJob(const QString& roomId, const QString& userId);