diff options
Diffstat (limited to 'lib/csapi/wellknown.h')
| -rw-r--r-- | lib/csapi/wellknown.h | 19 |
1 files changed, 8 insertions, 11 deletions
diff --git a/lib/csapi/wellknown.h b/lib/csapi/wellknown.h index bce67d00..94d3631c 100644 --- a/lib/csapi/wellknown.h +++ b/lib/csapi/wellknown.h @@ -10,13 +10,12 @@ #include "jobs/basejob.h" -namespace Quotient -{ +namespace Quotient { // Operations -/// Gets Matrix server discovery information about the domain. -/*! +/*! \brief Gets Matrix server discovery information about the domain. + * * Gets discovery information about the domain. The file may include * additional keys, which MUST follow the Java package naming convention, * e.g. ``com.example.myapp.property``. This ensures property names are @@ -26,19 +25,17 @@ namespace Quotient * Note that this endpoint is not necessarily handled by the homeserver, * but by another webserver, to be used for discovering the homeserver URL. */ -class GetWellknownJob : public BaseJob -{ +class GetWellknownJob : public BaseJob { public: + /// Gets Matrix server discovery information about the domain. explicit GetWellknownJob(); - /*! 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 - * GetWellknownJob is necessary but the job - * itself isn't. + * This function can be used when a URL for GetWellknownJob + * is necessary but the job itself isn't. */ static QUrl makeRequestUrl(QUrl baseUrl); - ~GetWellknownJob() override; // Result properties |