aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/versions.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/versions.h')
-rw-r--r--lib/csapi/versions.h20
1 files changed, 9 insertions, 11 deletions
diff --git a/lib/csapi/versions.h b/lib/csapi/versions.h
index aa8cbac6..4c4f8109 100644
--- a/lib/csapi/versions.h
+++ b/lib/csapi/versions.h
@@ -10,13 +10,12 @@
#include <QtCore/QHash>
-namespace Quotient
-{
+namespace Quotient {
// Operations
-/// Gets the versions of the specification supported by the server.
-/*!
+/*! \brief Gets the versions of the specification supported by the server.
+ *
* Gets the versions of the specification supported by the server.
*
* Values will take the form ``rX.Y.Z``.
@@ -38,25 +37,24 @@ namespace Quotient
* upgrade appropriately. Additionally, clients should avoid using unstable
* features in their stable releases.
*/
-class GetVersionsJob : public BaseJob
-{
+class GetVersionsJob : public BaseJob {
public:
+ /// Gets the versions of the specification supported by the server.
explicit GetVersionsJob();
- /*! 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
- * GetVersionsJob is necessary but the job
- * itself isn't.
+ * This function can be used when a URL for GetVersionsJob
+ * is necessary but the job itself isn't.
*/
static QUrl makeRequestUrl(QUrl baseUrl);
-
~GetVersionsJob() override;
// Result properties
/// The supported versions.
const QStringList& versions() const;
+
/// Experimental features the server supports. Features not listed here,
/// or the lack of this property all together, indicate that a feature is
/// not supported.