aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/device_management.h
diff options
context:
space:
mode:
authorKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-29 22:22:49 +0900
committerKitsune Ral <Kitsune-Ral@users.sf.net>2018-09-29 22:22:49 +0900
commitb55334ac0fe89f780776bc4eab90ffe1ca3c57bb (patch)
tree1a45c0ccfec8f5f7ba37eb4385cdc7f61afa0c97 /lib/csapi/device_management.h
parentf5c2e47fa1ab84fdaffe03c30ba973d7dea5ac05 (diff)
parent1e6510790dab6b9141ae52993987b406399668cd (diff)
downloadlibquotient-b55334ac0fe89f780776bc4eab90ffe1ca3c57bb.tar.gz
libquotient-b55334ac0fe89f780776bc4eab90ffe1ca3c57bb.zip
Merge branch 'cs-api-0.4.0'
Diffstat (limited to 'lib/csapi/device_management.h')
-rw-r--r--lib/csapi/device_management.h24
1 files changed, 12 insertions, 12 deletions
diff --git a/lib/csapi/device_management.h b/lib/csapi/device_management.h
index 338f8529..f41efdbc 100644
--- a/lib/csapi/device_management.h
+++ b/lib/csapi/device_management.h
@@ -16,7 +16,7 @@ namespace QMatrixClient
// Operations
/// List registered devices for the current user
- ///
+ ///
/// Gets information about all devices for the current user.
class GetDevicesJob : public BaseJob
{
@@ -47,13 +47,13 @@ namespace QMatrixClient
};
/// Get a single device
- ///
+ ///
/// Gets information on a single device, by device id.
class GetDeviceJob : public BaseJob
{
public:
/*! Get a single device
- * \param deviceId
+ * \param deviceId
* The device to retrieve.
*/
explicit GetDeviceJob(const QString& deviceId);
@@ -82,15 +82,15 @@ namespace QMatrixClient
};
/// Update a device
- ///
+ ///
/// Updates the metadata on the given device.
class UpdateDeviceJob : public BaseJob
{
public:
/*! Update a device
- * \param deviceId
+ * \param deviceId
* The device to update.
- * \param displayName
+ * \param displayName
* The new display name for this device. If not given, the
* display name is unchanged.
*/
@@ -98,7 +98,7 @@ namespace QMatrixClient
};
/// Delete a device
- ///
+ ///
/// This API endpoint uses the `User-Interactive Authentication API`_.
///
/// Deletes the given device, and invalidates any access token associated with it.
@@ -106,9 +106,9 @@ namespace QMatrixClient
{
public:
/*! Delete a device
- * \param deviceId
+ * \param deviceId
* The device to delete.
- * \param auth
+ * \param auth
* Additional authentication information for the
* user-interactive authentication API.
*/
@@ -116,7 +116,7 @@ namespace QMatrixClient
};
/// Bulk deletion of devices
- ///
+ ///
/// This API endpoint uses the `User-Interactive Authentication API`_.
///
/// Deletes the given devices, and invalidates any access token associated with them.
@@ -124,9 +124,9 @@ namespace QMatrixClient
{
public:
/*! Bulk deletion of devices
- * \param devices
+ * \param devices
* The list of device IDs to delete.
- * \param auth
+ * \param auth
* Additional authentication information for the
* user-interactive authentication API.
*/