diff options
Diffstat (limited to 'lib/csapi/versions.h')
| -rw-r--r-- | lib/csapi/versions.h | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/lib/csapi/versions.h b/lib/csapi/versions.h index 9f1a4831..3303752d 100644 --- a/lib/csapi/versions.h +++ b/lib/csapi/versions.h @@ -11,14 +11,23 @@ namespace QMatrixClient { // Operations + /// 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``. + /// + /// Only the latest ``Z`` value will be reported for each supported ``X.Y`` value. + /// i.e. if the server implements ``r0.0.0``, ``r0.0.1``, and ``r1.2.0``, it will report ``r0.0.1`` and ``r1.2.0``. class GetVersionsJob : public BaseJob { public: explicit GetVersionsJob(); - /** Construct a URL out of baseUrl and usual parameters passed to - * GetVersionsJob. This function can be used when - * a URL for GetVersionsJob is necessary but the job + /*! 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. */ static QUrl makeRequestUrl(QUrl baseUrl); @@ -27,6 +36,7 @@ namespace QMatrixClient // Result properties + /// The supported versions. const QStringList& versions() const; protected: |