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/joining.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/joining.h')
| -rw-r--r-- | lib/csapi/joining.h | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/lib/csapi/joining.h b/lib/csapi/joining.h index dd936f92..1b6f99e4 100644 --- a/lib/csapi/joining.h +++ b/lib/csapi/joining.h @@ -13,7 +13,7 @@ namespace Quotient { /*! \brief Start the requesting user participating in a particular room. * * *Note that this API requires a room ID, not alias.* - * ``/join/{roomIdOrAlias}`` *exists if you have a room alias.* + * `/join/{roomIdOrAlias}` *exists if you have a room alias.* * * This API starts a user participating in a particular room, if that user * is allowed to participate in that room. After this call, the client is @@ -21,7 +21,9 @@ namespace Quotient { * events associated with the room until the user leaves the room. * * After a user has joined a room, the room will appear as an entry in the - * response of the |/initialSync|_ and |/sync|_ APIs. + * response of the + * [`/initialSync`](/client-server-api/#get_matrixclientr0initialsync) and + * [`/sync`](/client-server-api/#get_matrixclientr0sync) APIs. */ class JoinRoomByIdJob : public BaseJob { public: @@ -32,7 +34,7 @@ public: * * \param thirdPartySigned * If supplied, the homeserver must verify that it matches a pending - * ``m.room.third_party_invite`` event in the room, and perform + * `m.room.third_party_invite` event in the room, and perform * key validity checking if required by the event. */ explicit JoinRoomByIdJob( @@ -48,7 +50,7 @@ public: /*! \brief Start the requesting user participating in a particular room. * * *Note that this API takes either a room ID or alias, unlike* - * ``/room/{roomId}/join``. + * `/room/{roomId}/join`. * * This API starts a user participating in a particular room, if that user * is allowed to participate in that room. After this call, the client is @@ -56,7 +58,9 @@ public: * events associated with the room until the user leaves the room. * * After a user has joined a room, the room will appear as an entry in the - * response of the |/initialSync|_ and |/sync|_ APIs. + * response of the + * [`/initialSync`](/client-server-api/#get_matrixclientr0initialsync) and + * [`/sync`](/client-server-api/#get_matrixclientr0sync) APIs. */ class JoinRoomJob : public BaseJob { public: @@ -70,8 +74,8 @@ public: * must be participating in the room. * * \param thirdPartySigned - * If a ``third_party_signed`` was supplied, the homeserver must verify - * that it matches a pending ``m.room.third_party_invite`` event in the + * If a `third_party_signed` was supplied, the homeserver must verify + * that it matches a pending `m.room.third_party_invite` event in the * room, and perform key validity checking if required by the event. */ explicit JoinRoomJob( |