diff options
Diffstat (limited to 'lib/csapi/kicking.h')
| -rw-r--r-- | lib/csapi/kicking.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/csapi/kicking.h b/lib/csapi/kicking.h index 0633a7f6..594f5845 100644 --- a/lib/csapi/kicking.h +++ b/lib/csapi/kicking.h @@ -8,8 +8,6 @@ namespace Quotient { -// Operations - /*! \brief Kick a user from the room. * * Kick a user from the room. @@ -26,10 +24,13 @@ class KickJob : public BaseJob { public: /*! \brief 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. |