aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/kicking.h
diff options
context:
space:
mode:
authorMarc Deop <marc@marcdeop.com>2019-03-02 12:26:57 +0100
committerMarc Deop <marc@marcdeop.com>2019-03-02 12:26:57 +0100
commitaacc4bcb4a487871daae6717f77605aaba444341 (patch)
tree4f50b6874821667ccb6b91c017e5d041e3846112 /lib/csapi/kicking.h
parentc971b924cd62822ed6fb1a0291c483ae73a3ecda (diff)
downloadlibquotient-aacc4bcb4a487871daae6717f77605aaba444341.tar.gz
libquotient-aacc4bcb4a487871daae6717f77605aaba444341.zip
style: apply .clang-format to all .cpp and .h files
Diffstat (limited to 'lib/csapi/kicking.h')
-rw-r--r--lib/csapi/kicking.h38
1 files changed, 19 insertions, 19 deletions
diff --git a/lib/csapi/kicking.h b/lib/csapi/kicking.h
index 714079cf..d75b8df3 100644
--- a/lib/csapi/kicking.h
+++ b/lib/csapi/kicking.h
@@ -6,32 +6,32 @@
#include "jobs/basejob.h"
-
-namespace QMatrixClient
-{
+namespace QMatrixClient {
// Operations
/// Kick a user from the room.
///
/// Kick a user from the room.
- ///
- /// The caller must have the required power level in order to perform this operation.
- ///
- /// Kicking a user adjusts the target member's membership state to be ``leave`` with an
- /// optional ``reason``. Like with other membership changes, a user can directly adjust
- /// the target member's state by making a request to ``/rooms/<room id>/state/m.room.member/<user id>``.
+ ///
+ /// The caller must have the required power level in order to perform this
+ /// operation.
+ ///
+ /// Kicking a user adjusts the target member's membership state to be
+ /// ``leave`` with an optional ``reason``. Like with other membership
+ /// changes, a user can directly adjust the target member's state by making
+ /// a request to ``/rooms/<room id>/state/m.room.member/<user id>``.
class KickJob : public BaseJob
{
public:
- /*! Kick a user from the room.
- * \param roomId
- * The room identifier (not alias) from which the user should be kicked.
- * \param userId
- * The fully qualified user ID of the user being kicked.
- * \param reason
- * The reason the user has been kicked. This will be supplied as the
- * ``reason`` on the target's updated `m.room.member`_ event.
- */
- explicit KickJob(const QString& roomId, const QString& userId, const QString& reason = {});
+ /*! Kick a user from the room.
+ * \param roomId
+ * The room identifier (not alias) from which the user should be
+ * kicked. \param userId The fully qualified user ID of the user being
+ * kicked. \param reason The reason the user has been kicked. This will
+ * be supplied as the
+ * ``reason`` on the target's updated `m.room.member`_ event.
+ */
+ explicit KickJob(const QString& roomId, const QString& userId,
+ const QString& reason = {});
};
} // namespace QMatrixClient