Re-generate API files

1 files changed, 68 insertions, 79 deletions

diff --git a/lib/csapi/registration.h b/lib/csapi/registration.h
index 6864fd47..0ad8b101 100644
--- a/lib/csapi/registration.h
+++ b/lib/csapi/registration.h
@@ -15,8 +15,9 @@ namespace Quotient {
 
 /*! \brief Register for an account on this homeserver.
  *
- * This API endpoint uses the `User-Interactive Authentication API`_, except in
- * the cases where a guest account is being registered.
+ * This API endpoint uses the [User-Interactive Authentication
+ * API](/client-server-api/#user-interactive-authentication-api), except in the
+ * cases where a guest account is being registered.
  *
  * Register for an account on this homeserver.
  *
@@ -31,45 +32,46 @@ namespace Quotient {
  * If registration is successful, this endpoint will issue an access token
  * the client can use to authorize itself in subsequent requests.
  *
- * If the client does not supply a ``device_id``, the server must
+ * If the client does not supply a `device_id`, the server must
  * auto-generate one.
  *
  * The server SHOULD register an account with a User ID based on the
- * ``username`` provided, if any. Note that the grammar of Matrix User ID
+ * `username` provided, if any. Note that the grammar of Matrix User ID
  * localparts is restricted, so the server MUST either map the provided
- * ``username`` onto a ``user_id`` in a logical manner, or reject
- * ``username``\s which do not comply to the grammar, with
- * ``M_INVALID_USERNAME``.
+ * `username` onto a `user_id` in a logical manner, or reject
+ * `username`\s which do not comply to the grammar, with
+ * `M_INVALID_USERNAME`.
  *
  * Matrix clients MUST NOT assume that localpart of the registered
- * ``user_id`` matches the provided ``username``.
+ * `user_id` matches the provided `username`.
  *
- * The returned access token must be associated with the ``device_id``
+ * The returned access token must be associated with the `device_id`
  * supplied by the client or generated by the server. The server may
  * invalidate any access token previously associated with that device. See
- * `Relationship between access tokens and devices`_.
+ * [Relationship between access tokens and
+ * devices](/client-server-api/#relationship-between-access-tokens-and-devices).
  *
  * When registering a guest account, all parameters in the request body
- * with the exception of ``initial_device_display_name`` MUST BE ignored
- * by the server. The server MUST pick a ``device_id`` for the account
+ * with the exception of `initial_device_display_name` MUST BE ignored
+ * by the server. The server MUST pick a `device_id` for the account
  * regardless of input.
  *
  * Any user ID returned by this API must conform to the grammar given in the
- * `Matrix specification <../appendices.html#user-identifiers>`_.
+ * [Matrix specification](/appendices/#user-identifiers).
  */
 class RegisterJob : public BaseJob {
 public:
     /*! \brief Register for an account on this homeserver.
      *
      * \param kind
-     *   The kind of account to register. Defaults to ``user``.
+     *   The kind of account to register. Defaults to `user`.
      *
      * \param auth
      *   Additional authentication information for the
      *   user-interactive authentication API. Note that this
      *   information is *not* used to define how the registered user
      *   should be authenticated, but is instead used to
-     *   authenticate the ``register`` call itself.
+     *   authenticate the `register` call itself.
      *
      * \param username
      *   The basis for the localpart of the desired Matrix ID. If omitted,
@@ -85,10 +87,10 @@ public:
      *
      * \param initialDeviceDisplayName
      *   A display name to assign to the newly-created device. Ignored
-     *   if ``device_id`` corresponds to a known device.
+     *   if `device_id` corresponds to a known device.
      *
      * \param inhibitLogin
-     *   If true, an ``access_token`` and ``device_id`` should not be
+     *   If true, an `access_token` and `device_id` should not be
      *   returned from this call, therefore preventing an automatic
      *   login. Defaults to false.
      */
@@ -105,12 +107,15 @@ public:
     /// The fully-qualified Matrix user ID (MXID) that has been registered.
     ///
     /// Any user ID returned by this API must conform to the grammar given in
-    /// the `Matrix specification <../appendices.html#user-identifiers>`_.
-    QString userId() const { return loadFromJson<QString>("user_id"_ls); }
+    /// the [Matrix specification](/appendices/#user-identifiers).
+    QString userId() const
+    {
+        return loadFromJson<QString>("user_id"_ls);
+    }
 
     /// An access token for the account.
     /// This access token can then be used to authorize other requests.
-    /// Required if the ``inhibit_login`` option is false.
+    /// Required if the `inhibit_login` option is false.
     QString accessToken() const
     {
         return loadFromJson<QString>("access_token"_ls);
@@ -120,8 +125,8 @@ public:
     /// been registered.
     ///
     /// **Deprecated**. Clients should extract the server_name from
-    /// ``user_id`` (by splitting at the first colon) if they require
-    /// it. Note also that ``homeserver`` is not spelt this way.
+    /// `user_id` (by splitting at the first colon) if they require
+    /// it. Note also that `homeserver` is not spelt this way.
     QString homeServer() const
     {
         return loadFromJson<QString>("home_server"_ls);
@@ -129,8 +134,11 @@ public:
 
     /// ID of the registered device. Will be the same as the
     /// corresponding parameter in the request, if one was specified.
-    /// Required if the ``inhibit_login`` option is false.
-    QString deviceId() const { return loadFromJson<QString>("device_id"_ls); }
+    /// Required if the `inhibit_login` option is false.
+    QString deviceId() const
+    {
+        return loadFromJson<QString>("device_id"_ls);
+    }
 };
 
 /*! \brief Begins the validation process for an email to be used during
@@ -201,9 +209,9 @@ public:
  *
  * Changes the password for an account on this homeserver.
  *
- * This API endpoint uses the `User-Interactive Authentication API`_ to
- * ensure the user changing the password is actually the owner of the
- * account.
+ * This API endpoint uses the [User-Interactive Authentication
+ * API](/client-server-api/#user-interactive-authentication-api) to ensure the
+ * user changing the password is actually the owner of the account.
  *
  * An access token should be submitted to this endpoint if the client has
  * an active session.
@@ -224,8 +232,8 @@ public:
      *   Whether the user's other access tokens, and their associated devices,
      * should be revoked if the request succeeds.
      *
-     *   When ``false``, the server can still take advantage of `the soft logout
-     * method <#soft-logout>`_ for the user's remaining devices.
+     *   When `false`, the server can still take advantage of the [soft logout
+     * method](/client-server-api/#soft-logout) for the user's remaining devices.
      *
      * \param auth
      *   Additional authentication information for the user-interactive
@@ -242,23 +250,18 @@ public:
  * The homeserver must check that the given email address **is
  * associated** with an account on this homeserver. This API should be
  * used to request validation tokens when authenticating for the
- * ``/account/password`` endpoint.
+ * `/account/password` endpoint.
  *
  * This API's parameters and response are identical to that of the
- * |/register/email/requestToken|_ endpoint, except that
- * ``M_THREEPID_NOT_FOUND`` may be returned if no account matching the
+ * [`/register/email/requestToken`](/client-server-api/#post_matrixclientr0registeremailrequesttoken)
+ * endpoint, except that
+ * `M_THREEPID_NOT_FOUND` may be returned if no account matching the
  * given email address could be found. The server may instead send an
  * email to the given address prompting the user to create an account.
- * ``M_THREEPID_IN_USE`` may not be returned.
+ * `M_THREEPID_IN_USE` may not be returned.
  *
  * The homeserver should validate the email itself, either by sending a
  * validation email itself or by using a service it has control over.
- *
- *
- * .. |/register/email/requestToken| replace:: ``/register/email/requestToken``
- *
- * .. _/register/email/requestToken:
- * #post-matrix-client-r0-register-email-requesttoken
  */
 class RequestTokenToResetPasswordEmailJob : public BaseJob {
 public:
@@ -269,24 +272,18 @@ public:
      *   The homeserver must check that the given email address **is
      *   associated** with an account on this homeserver. This API should be
      *   used to request validation tokens when authenticating for the
-     *   ``/account/password`` endpoint.
+     *   `/account/password` endpoint.
      *
      *   This API's parameters and response are identical to that of the
-     *   |/register/email/requestToken|_ endpoint, except that
-     *   ``M_THREEPID_NOT_FOUND`` may be returned if no account matching the
+     *   [`/register/email/requestToken`](/client-server-api/#post_matrixclientr0registeremailrequesttoken)
+     *   endpoint, except that
+     *   `M_THREEPID_NOT_FOUND` may be returned if no account matching the
      *   given email address could be found. The server may instead send an
      *   email to the given address prompting the user to create an account.
-     *   ``M_THREEPID_IN_USE`` may not be returned.
+     *   `M_THREEPID_IN_USE` may not be returned.
      *
      *   The homeserver should validate the email itself, either by sending a
      *   validation email itself or by using a service it has control over.
-     *
-     *
-     *   .. |/register/email/requestToken| replace::
-     * ``/register/email/requestToken``
-     *
-     *   .. _/register/email/requestToken:
-     * #post-matrix-client-r0-register-email-requesttoken
      */
     explicit RequestTokenToResetPasswordEmailJob(const EmailValidationData& body);
 
@@ -305,22 +302,18 @@ public:
  * The homeserver must check that the given phone number **is
  * associated** with an account on this homeserver. This API should be
  * used to request validation tokens when authenticating for the
- * ``/account/password`` endpoint.
+ * `/account/password` endpoint.
  *
  * This API's parameters and response are identical to that of the
- * |/register/msisdn/requestToken|_ endpoint, except that
- * ``M_THREEPID_NOT_FOUND`` may be returned if no account matching the
+ * [`/register/msisdn/requestToken`](/client-server-api/#post_matrixclientr0registermsisdnrequesttoken)
+ * endpoint, except that
+ * `M_THREEPID_NOT_FOUND` may be returned if no account matching the
  * given phone number could be found. The server may instead send the SMS
  * to the given phone number prompting the user to create an account.
- * ``M_THREEPID_IN_USE`` may not be returned.
+ * `M_THREEPID_IN_USE` may not be returned.
  *
  * The homeserver should validate the phone number itself, either by sending a
  * validation message itself or by using a service it has control over.
- *
- * .. |/register/msisdn/requestToken| replace:: ``/register/msisdn/requestToken``
- *
- * .. _/register/msisdn/requestToken:
- * #post-matrix-client-r0-register-email-requesttoken
  */
 class RequestTokenToResetPasswordMSISDNJob : public BaseJob {
 public:
@@ -331,23 +324,18 @@ public:
      *   The homeserver must check that the given phone number **is
      *   associated** with an account on this homeserver. This API should be
      *   used to request validation tokens when authenticating for the
-     *   ``/account/password`` endpoint.
+     *   `/account/password` endpoint.
      *
      *   This API's parameters and response are identical to that of the
-     *   |/register/msisdn/requestToken|_ endpoint, except that
-     *   ``M_THREEPID_NOT_FOUND`` may be returned if no account matching the
+     *   [`/register/msisdn/requestToken`](/client-server-api/#post_matrixclientr0registermsisdnrequesttoken)
+     *   endpoint, except that
+     *   `M_THREEPID_NOT_FOUND` may be returned if no account matching the
      *   given phone number could be found. The server may instead send the SMS
      *   to the given phone number prompting the user to create an account.
-     *   ``M_THREEPID_IN_USE`` may not be returned.
+     *   `M_THREEPID_IN_USE` may not be returned.
      *
      *   The homeserver should validate the phone number itself, either by sending
      * a validation message itself or by using a service it has control over.
-     *
-     *   .. |/register/msisdn/requestToken| replace::
-     * ``/register/msisdn/requestToken``
-     *
-     *   .. _/register/msisdn/requestToken:
-     * #post-matrix-client-r0-register-email-requesttoken
      */
     explicit RequestTokenToResetPasswordMSISDNJob(
         const MsisdnValidationData& body);
@@ -366,7 +354,8 @@ public:
  * Deactivate the user's account, removing all ability for the user to
  * login again.
  *
- * This API endpoint uses the `User-Interactive Authentication API`_.
+ * This API endpoint uses the [User-Interactive Authentication
+ * API](/client-server-api/#user-interactive-authentication-api).
  *
  * An access token should be submitted to this endpoint if the client has
  * an active session.
@@ -374,7 +363,7 @@ public:
  * The homeserver may change the flows available depending on whether a
  * valid access token is provided.
  *
- * Unlike other endpoints, this endpoint does not take an ``id_access_token``
+ * Unlike other endpoints, this endpoint does not take an `id_access_token`
  * parameter because the homeserver is expected to sign the request to the
  * identity server instead.
  */
@@ -388,11 +377,11 @@ public:
      *
      * \param idServer
      *   The identity server to unbind all of the user's 3PIDs from.
-     *   If not provided, the homeserver MUST use the ``id_server``
+     *   If not provided, the homeserver MUST use the `id_server`
      *   that was originally use to bind each identifier. If the
-     *   homeserver does not know which ``id_server`` that was,
-     *   it must return an ``id_server_unbind_result`` of
-     *   ``no-support``.
+     *   homeserver does not know which `id_server` that was,
+     *   it must return an `id_server_unbind_result` of
+     *   `no-support`.
      */
     explicit DeactivateAccountJob(const Omittable<AuthenticationData>& auth = none,
                                   const QString& idServer = {});
@@ -400,12 +389,12 @@ public:
     // Result properties
 
     /// An indicator as to whether or not the homeserver was able to unbind
-    /// the user's 3PIDs from the identity server(s). ``success`` indicates
+    /// the user's 3PIDs from the identity server(s). `success` indicates
     /// that all identifiers have been unbound from the identity server while
-    /// ``no-support`` indicates that one or more identifiers failed to unbind
+    /// `no-support` indicates that one or more identifiers failed to unbind
     /// due to the identity server refusing the request or the homeserver
     /// being unable to determine an identity server to unbind from. This
-    /// must be ``success`` if the homeserver has no identifiers to unbind
+    /// must be `success` if the homeserver has no identifiers to unbind
     /// for the user.
     QString idServerUnbindResult() const
     {
@@ -447,7 +436,7 @@ public:
     // Result properties
 
     /// A flag to indicate that the username is available. This should always
-    /// be ``true`` when the server replies with 200 OK.
+    /// be `true` when the server replies with 200 OK.
     Omittable<bool> available() const
     {
         return loadFromJson<Omittable<bool>>("available"_ls);