From e17764a1ae81393968dfb747c7b67353c109bc71 Mon Sep 17 00:00:00 2001
From: Kitsune Ral <Kitsune-Ral@users.sf.net>
Date: Fri, 19 Jun 2020 15:01:33 +0200
Subject: csapi/: generated using the latest GTAD and matrix-doc

For matrix-doc, specifically, it is master (5cb4b086) merged with
https://github.com/matrix-org/matrix-doc/pull/2518.
---
 lib/csapi/joining.h | 42 +++++-------------------------------------
 1 file changed, 5 insertions(+), 37 deletions(-)

(limited to 'lib/csapi/joining.h')

diff --git a/lib/csapi/joining.h b/lib/csapi/joining.h
index 6822fbdf..dd936f92 100644
--- a/lib/csapi/joining.h
+++ b/lib/csapi/joining.h
@@ -12,8 +12,8 @@ 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.*
+ * *Note that this API requires a room ID, not 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
@@ -22,34 +22,18 @@ namespace Quotient {
  *
  * After a user has joined a room, the room will appear as an entry in the
  * response of the |/initialSync|_ and |/sync|_ APIs.
- *
- * 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.
  */
 class JoinRoomByIdJob : public BaseJob {
 public:
     /*! \brief Start the requesting user participating in a particular room.
-     *
      *
      * \param roomId
      *   The room identifier (not alias) to join.
      *
      * \param thirdPartySigned
-     *   *Note that this API requires a room ID, not 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
-     *   allowed to see all current state events in the room, and all subsequent
-     *   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.
-     *
-     *   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.
+     *   If 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 JoinRoomByIdJob(
         const QString& roomId,
@@ -73,15 +57,10 @@ public:
  *
  * After a user has joined a room, the room will appear as an entry in the
  * response of the |/initialSync|_ and |/sync|_ APIs.
- *
- * 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.
  */
 class JoinRoomJob : public BaseJob {
 public:
     /*! \brief Start the requesting user participating in a particular room.
-     *
      *
      * \param roomIdOrAlias
      *   The room identifier or alias to join.
@@ -91,17 +70,6 @@ public:
      *   must be participating in the room.
      *
      * \param thirdPartySigned
-     *   *Note that this API takes either a room ID or alias, unlike*
-     * ``/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
-     *   allowed to see all current state events in the room, and all subsequent
-     *   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.
-     *
      *   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.
-- 
cgit v1.2.3