From 7036ed0dcb137cb5cbb6b426dd338c5e2e4c6424 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Fri, 17 Apr 2020 07:42:13 +0200 Subject: Regenerate API files using new GTAD and refreshed templates No functional changes. --- lib/csapi/users.h | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) (limited to 'lib/csapi/users.h') diff --git a/lib/csapi/users.h b/lib/csapi/users.h index d9a16a9d..de4eb529 100644 --- a/lib/csapi/users.h +++ b/lib/csapi/users.h @@ -10,13 +10,12 @@ #include -namespace Quotient -{ +namespace Quotient { // Operations -/// Searches the user directory. -/*! +/*! \brief Searches the user directory. + * * Performs a search for users on the homeserver. The homeserver may * determine which subset of users are searched, however the homeserver * MUST at a minimum consider the users the requesting user shares a @@ -28,22 +27,21 @@ namespace Quotient * names preferably using a collation determined based upon the * ``Accept-Language`` header provided in the request, if present. */ -class SearchUserDirectoryJob : public BaseJob -{ +class SearchUserDirectoryJob : public BaseJob { public: // Inner data structures - /// Performs a search for users on the homeserver. The homeserver - /// maydetermine which subset of users are searched, however the - /// homeserverMUST at a minimum consider the users the requesting user - /// shares aroom with and those who reside in public rooms (known to the - /// homeserver).The search MUST consider local users to the homeserver, and - /// SHOULDquery remote users as part of the search.The search is performed - /// case-insensitively on user IDs and displaynames preferably using a - /// collation determined based upon the ``Accept-Language`` header provided - /// in the request, if present. - struct User - { + /// Performs a search for users on the homeserver. The homeserver may + /// determine which subset of users are searched, however the homeserver + /// MUST at a minimum consider the users the requesting user shares a + /// room with and those who reside in public rooms (known to the + /// homeserver). The search MUST consider local users to the homeserver, and + /// SHOULD query remote users as part of the search. + /// + /// The search is performed case-insensitively on user IDs and display + /// names preferably using a collation determined based upon the + /// ``Accept-Language`` header provided in the request, if present. + struct User { /// The user's matrix user ID. QString userId; /// The display name of the user, if one exists. @@ -54,7 +52,8 @@ public: // Construction/destruction - /*! Searches the user directory. + /*! \brief Searches the user directory. + * * \param searchTerm * The term to search for * \param limit @@ -69,6 +68,7 @@ public: /// Ordered by rank and then whether or not profile info is available. const QVector& results() const; + /// Indicates if the result list has been truncated by the limit. bool limited() const; -- cgit v1.2.3