Regenerate API files using new GTAD and refreshed templates

No functional changes.

1 files changed, 53 insertions, 62 deletions

diff --git a/lib/csapi/third_party_lookup.h b/lib/csapi/third_party_lookup.h
index 63607549..c8ca8cbb 100644
--- a/lib/csapi/third_party_lookup.h
+++ b/lib/csapi/third_party_lookup.h
@@ -15,30 +15,27 @@
 #include <QtCore/QHash>
 #include <QtCore/QVector>
 
-namespace Quotient
-{
+namespace Quotient {
 
 // Operations
 
-/// Retrieve metadata about all protocols that a homeserver supports.
-/*!
+/*! \brief Retrieve metadata about all protocols that a homeserver supports.
+ *
  * Fetches the overall metadata about protocols supported by the
  * homeserver. Includes both the available protocols and all fields
  * required for queries against each protocol.
  */
-class GetProtocolsJob : public BaseJob
-{
+class GetProtocolsJob : public BaseJob {
 public:
+    /// Retrieve metadata about all protocols that a homeserver supports.
     explicit GetProtocolsJob();
 
-    /*! Construct a URL without creating a full-fledged job object
+    /*! \brief Construct a URL without creating a full-fledged job object
      *
-     * This function can be used when a URL for
-     * GetProtocolsJob is necessary but the job
-     * itself isn't.
+     * This function can be used when a URL for GetProtocolsJob
+     * is necessary but the job itself isn't.
      */
     static QUrl makeRequestUrl(QUrl baseUrl);
-
     ~GetProtocolsJob() override;
 
     // Result properties
@@ -54,27 +51,28 @@ private:
     QScopedPointer<Private> d;
 };
 
-/// Retrieve metadata about a specific protocol that the homeserver supports.
-/*!
+/*! \brief Retrieve metadata about a specific protocol that the homeserver
+ * supports.
+ *
  * Fetches the metadata from the homeserver about a particular third party
  * protocol.
  */
-class GetProtocolMetadataJob : public BaseJob
-{
+class GetProtocolMetadataJob : public BaseJob {
 public:
-    /*! Retrieve metadata about a specific protocol that the homeserver
-     * supports. \param protocol The name of the protocol.
+    /*! \brief Retrieve metadata about a specific protocol that the homeserver
+     * supports.
+     *
+     * \param protocol
+     *   The name of the protocol.
      */
     explicit GetProtocolMetadataJob(const QString& protocol);
 
-    /*! Construct a URL without creating a full-fledged job object
+    /*! \brief Construct a URL without creating a full-fledged job object
      *
-     * This function can be used when a URL for
-     * GetProtocolMetadataJob is necessary but the job
-     * itself isn't.
+     * This function can be used when a URL for GetProtocolMetadataJob
+     * is necessary but the job itself isn't.
      */
     static QUrl makeRequestUrl(QUrl baseUrl, const QString& protocol);
-
     ~GetProtocolMetadataJob() override;
 
     // Result properties
@@ -90,8 +88,8 @@ private:
     QScopedPointer<Private> d;
 };
 
-/// Retrieve Matrix-side portals rooms leading to a third party location.
-/*!
+/*! \brief Retrieve Matrix-side portals rooms leading to a third party location.
+ *
  * Requesting this endpoint with a valid protocol name results in a list
  * of successful mapping results in a JSON array. Each result contains
  * objects to represent the Matrix room or rooms that represent a portal
@@ -101,10 +99,11 @@ private:
  * identifier. It should attempt to canonicalise the identifier as much
  * as reasonably possible given the network type.
  */
-class QueryLocationByProtocolJob : public BaseJob
-{
+class QueryLocationByProtocolJob : public BaseJob {
 public:
-    /*! Retrieve Matrix-side portals rooms leading to a third party location.
+    /*! \brief Retrieve Matrix-side portals rooms leading to a third party
+     * location.
+     *
      * \param protocol
      *   The protocol used to communicate to the third party network.
      * \param searchFields
@@ -114,15 +113,13 @@ public:
     explicit QueryLocationByProtocolJob(const QString& protocol,
                                         const QString& searchFields = {});
 
-    /*! Construct a URL without creating a full-fledged job object
+    /*! \brief Construct a URL without creating a full-fledged job object
      *
-     * This function can be used when a URL for
-     * QueryLocationByProtocolJob is necessary but the job
-     * itself isn't.
+     * This function can be used when a URL for QueryLocationByProtocolJob
+     * is necessary but the job itself isn't.
      */
     static QUrl makeRequestUrl(QUrl baseUrl, const QString& protocol,
                                const QString& searchFields = {});
-
     ~QueryLocationByProtocolJob() override;
 
     // Result properties
@@ -138,15 +135,15 @@ private:
     QScopedPointer<Private> d;
 };
 
-/// Retrieve the Matrix User ID of a corresponding third party user.
-/*!
+/*! \brief Retrieve the Matrix User ID of a corresponding third party user.
+ *
  * Retrieve a Matrix User ID linked to a user on the third party service, given
  * a set of user parameters.
  */
-class QueryUserByProtocolJob : public BaseJob
-{
+class QueryUserByProtocolJob : public BaseJob {
 public:
-    /*! Retrieve the Matrix User ID of a corresponding third party user.
+    /*! \brief Retrieve the Matrix User ID of a corresponding third party user.
+     *
      * \param protocol
      *   The name of the protocol.
      * \param fields
@@ -156,15 +153,13 @@ public:
     explicit QueryUserByProtocolJob(const QString& protocol,
                                     const QString& fields = {});
 
-    /*! Construct a URL without creating a full-fledged job object
+    /*! \brief Construct a URL without creating a full-fledged job object
      *
-     * This function can be used when a URL for
-     * QueryUserByProtocolJob is necessary but the job
-     * itself isn't.
+     * This function can be used when a URL for QueryUserByProtocolJob
+     * is necessary but the job itself isn't.
      */
     static QUrl makeRequestUrl(QUrl baseUrl, const QString& protocol,
                                const QString& fields = {});
-
     ~QueryUserByProtocolJob() override;
 
     // Result properties
@@ -180,28 +175,26 @@ private:
     QScopedPointer<Private> d;
 };
 
-/// Reverse-lookup third party locations given a Matrix room alias.
-/*!
+/*! \brief Reverse-lookup third party locations given a Matrix room alias.
+ *
  * Retrieve an array of third party network locations from a Matrix room
  * alias.
  */
-class QueryLocationByAliasJob : public BaseJob
-{
+class QueryLocationByAliasJob : public BaseJob {
 public:
-    /*! Reverse-lookup third party locations given a Matrix room alias.
+    /*! \brief Reverse-lookup third party locations given a Matrix room alias.
+     *
      * \param alias
      *   The Matrix room alias to look up.
      */
     explicit QueryLocationByAliasJob(const QString& alias);
 
-    /*! Construct a URL without creating a full-fledged job object
+    /*! \brief Construct a URL without creating a full-fledged job object
      *
-     * This function can be used when a URL for
-     * QueryLocationByAliasJob is necessary but the job
-     * itself isn't.
+     * This function can be used when a URL for QueryLocationByAliasJob
+     * is necessary but the job itself isn't.
      */
     static QUrl makeRequestUrl(QUrl baseUrl, const QString& alias);
-
     ~QueryLocationByAliasJob() override;
 
     // Result properties
@@ -217,27 +210,25 @@ private:
     QScopedPointer<Private> d;
 };
 
-/// Reverse-lookup third party users given a Matrix User ID.
-/*!
+/*! \brief Reverse-lookup third party users given a Matrix User ID.
+ *
  * Retrieve an array of third party users from a Matrix User ID.
  */
-class QueryUserByIDJob : public BaseJob
-{
+class QueryUserByIDJob : public BaseJob {
 public:
-    /*! Reverse-lookup third party users given a Matrix User ID.
+    /*! \brief Reverse-lookup third party users given a Matrix User ID.
+     *
      * \param userid
      *   The Matrix User ID to look up.
      */
     explicit QueryUserByIDJob(const QString& userid);
 
-    /*! Construct a URL without creating a full-fledged job object
+    /*! \brief Construct a URL without creating a full-fledged job object
      *
-     * This function can be used when a URL for
-     * QueryUserByIDJob is necessary but the job
-     * itself isn't.
+     * This function can be used when a URL for QueryUserByIDJob
+     * is necessary but the job itself isn't.
      */
     static QUrl makeRequestUrl(QUrl baseUrl, const QString& userid);
-
     ~QueryUserByIDJob() override;
 
     // Result properties