csapi: Doxy-comments thanks to the latest GTAD

1 files changed, 16 insertions, 0 deletions

diff --git a/lib/csapi/to_device.h b/lib/csapi/to_device.h
index e3f3b9e8..6aff3ae5 100644
--- a/lib/csapi/to_device.h
+++ b/lib/csapi/to_device.h
@@ -13,9 +13,25 @@ namespace QMatrixClient
 {
     // Operations
 
+    /// Send an event to a given set of devices.
+    /// 
+    /// This endpoint is used to send send-to-device events to a set of
+    /// client devices.
     class SendToDeviceJob : public BaseJob
     {
         public:
+            /*! Send an event to a given set of devices.
+             * \param eventType 
+             *   The type of event to send.
+             * \param txnId 
+             *   The transaction ID for this event. Clients should generate an
+             *   ID unique across requests with the same access token; it will be
+             *   used by the server to ensure idempotency of requests.
+             * \param messages 
+             *   The messages to send. A map from user ID, to a map from
+             *   device ID to message body. The device ID may also be `*`,
+             *   meaning all known devices for the user.
+             */
             explicit SendToDeviceJob(const QString& eventType, const QString& txnId, const QHash<QString, QHash<QString, QJsonObject>>& messages = {});
     };
 } // namespace QMatrixClient