aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/banning.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2020-06-09 08:52:25 +0200
committerGitHub <noreply@github.com>2020-06-09 08:52:25 +0200
commit370d9b3e46332d38df8798cda208c534c58be808 (patch)
treef3db0cd7463468ff52c74446acd608356f8b8ab6 /lib/csapi/banning.h
parente1f5d0aa2c33e6da6c3a609c8bc7e0b5867e748d (diff)
parent10d9ac4673e374a9ac17ff492591136520337c4c (diff)
downloadlibquotient-370d9b3e46332d38df8798cda208c534c58be808.tar.gz
libquotient-370d9b3e46332d38df8798cda208c534c58be808.zip
Merge pull request #405 from quotient-im/kitsune-basejob-store-json-response
Store JSON response in BaseJob + tweaks to the generated code
Diffstat (limited to 'lib/csapi/banning.h')
-rw-r--r--lib/csapi/banning.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/csapi/banning.h b/lib/csapi/banning.h
index 6bf782e7..4faaaa81 100644
--- a/lib/csapi/banning.h
+++ b/lib/csapi/banning.h
@@ -8,8 +8,6 @@
namespace Quotient {
-// Operations
-
/*! \brief Ban a user in the room.
*
* Ban a user in the room. If the user is currently in the room, also kick them.
@@ -24,10 +22,13 @@ class BanJob : public BaseJob {
public:
/*! \brief Ban a user in the room.
*
+ *
* \param roomId
* The room identifier (not alias) from which the user should be banned.
+ *
* \param userId
* The fully qualified user ID of the user being banned.
+ *
* \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.
@@ -49,8 +50,10 @@ class UnbanJob : public BaseJob {
public:
/*! \brief Unban a user from the room.
*
+ *
* \param roomId
* The room identifier (not alias) from which the user should be unbanned.
+ *
* \param userId
* The fully qualified user ID of the user being unbanned.
*/