diff options
| author | Alexey Rusakov <Kitsune-Ral@users.sf.net> | 2021-06-23 13:42:45 +0200 |
|---|---|---|
| committer | Alexey Rusakov <Kitsune-Ral@users.sf.net> | 2021-06-23 13:42:45 +0200 |
| commit | ebea54ba87558e50604976821f378d125f6b498e (patch) | |
| tree | ff0a8aa1b28631b6503826ad26a61b0922abff0a /lib/csapi/kicking.h | |
| parent | 607d8603b6d5b8409aa3f0275d8dfc8d0b5fbaa0 (diff) | |
| download | libquotient-ebea54ba87558e50604976821f378d125f6b498e.tar.gz libquotient-ebea54ba87558e50604976821f378d125f6b498e.zip | |
Re-generated API files according to the previous commit
Only API-preserving changes are included in this branch (0.7 will have
all changes).
Diffstat (limited to 'lib/csapi/kicking.h')
| -rw-r--r-- | lib/csapi/kicking.h | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/lib/csapi/kicking.h b/lib/csapi/kicking.h index 2645a54f..11018368 100644 --- a/lib/csapi/kicking.h +++ b/lib/csapi/kicking.h @@ -15,10 +15,10 @@ namespace Quotient { * 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 + * 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>``. + * `/rooms/<room id>/state/m.room.member/<user id>`. */ class KickJob : public BaseJob { public: @@ -32,7 +32,8 @@ public: * * \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. + * `reason` on the target's updated + * [`m.room.member`](/client-server-api/#mroommember) event. */ explicit KickJob(const QString& roomId, const QString& userId, const QString& reason = {}); |