csapi: Doxy-comments thanks to the latest GTAD

1 files changed, 37 insertions, 3 deletions

diff --git a/lib/csapi/admin.h b/lib/csapi/admin.h
index 087eabf0..b1b23ded 100644
--- a/lib/csapi/admin.h
+++ b/lib/csapi/admin.h
@@ -14,35 +14,67 @@ namespace QMatrixClient
 {
     // Operations
 
+    /// Gets information about a particular user.
+    /// 
+    /// Gets information about a particular user.
+    /// 
+    /// This API may be restricted to only be called by the user being looked
+    /// up, or by a server admin. Server-local administrator privileges are not
+    /// specified in this document.
     class GetWhoIsJob : public BaseJob
     {
         public:
             // Inner data structures
 
+            /// Gets information about a particular user.
+            /// 
+            /// This API may be restricted to only be called by the user being looked
+            /// up, or by a server admin. Server-local administrator privileges are not
+            /// specified in this document.
             struct ConnectionInfo
             {
+        /// Most recently seen IP address of the session.
                 QString ip;
+        /// Unix timestamp that the session was last active.
                 Omittable<qint64> lastSeen;
+        /// User agent string last seen in the session.
                 QString userAgent;
             };
 
+            /// Gets information about a particular user.
+            /// 
+            /// This API may be restricted to only be called by the user being looked
+            /// up, or by a server admin. Server-local administrator privileges are not
+            /// specified in this document.
             struct SessionInfo
             {
+        /// Information particular connections in the session.
                 QVector<ConnectionInfo> connections;
             };
 
+            /// Gets information about a particular user.
+            /// 
+            /// This API may be restricted to only be called by the user being looked
+            /// up, or by a server admin. Server-local administrator privileges are not
+            /// specified in this document.
             struct DeviceInfo
             {
+        /// A user's sessions (i.e. what they did with an access token from one login).
                 QVector<SessionInfo> sessions;
             };
 
             // Construction/destruction
 
+            /*! Gets information about a particular user.
+             * \param userId 
+             *   The user to look up.
+             */
             explicit GetWhoIsJob(const QString& userId);
 
-            /** Construct a URL out of baseUrl and usual parameters passed to
-             * GetWhoIsJob. This function can be used when
-             * a URL for GetWhoIsJob is necessary but the job
+            /*! Construct a URL without creating a full-fledged job object
+             *
+             * This function can be used when a URL for
+             * GetWhoIsJob is necessary but the job
              * itself isn't.
              */
             static QUrl makeRequestUrl(QUrl baseUrl, const QString& userId);
@@ -51,7 +83,9 @@ namespace QMatrixClient
 
             // Result properties
 
+            /// The Matrix user ID of the user.
             const QString& userId() const;
+            /// Each key is an identitfier for one of the user's devices.
             const QHash<QString, DeviceInfo>& devices() const;
 
         protected: