From 83da52582bfaa03b76e1176c47e2eb6978944f6a Mon Sep 17 00:00:00 2001
From: James Graham <james.h.graham@protonmail.com>
Date: Sun, 30 Apr 2023 19:13:13 +0000
Subject: [PATCH] Document matriximageprovider

---
 src/matriximageprovider.h | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/src/matriximageprovider.h b/src/matriximageprovider.h
index 5af739f34..a1ec6fe62 100644
--- a/src/matriximageprovider.h
+++ b/src/matriximageprovider.h
@@ -15,6 +15,13 @@ namespace Quotient
 class Connection;
 }
 
+/**
+ * @class ThumbnailResponse
+ *
+ * A QQuickImageResponse for an mxc image.
+ *
+ * @sa QQuickImageResponse
+ */
 class ThumbnailResponse : public QQuickImageResponse
 {
     Q_OBJECT
@@ -40,8 +47,20 @@ private:
     QString errorString() const override;
 };
 
+/**
+ * @class MatrixImageProvider
+ *
+ * A QQuickAsyncImageProvider for mxc images.
+ *
+ * @sa QQuickAsyncImageProvider
+ */
 class MatrixImageProvider : public QQuickAsyncImageProvider
 {
 public:
+    /**
+     * @brief Return a job to provide the image with the given ID.
+     *
+     * @sa QQuickAsyncImageProvider::requestImageResponse
+     */
     QQuickImageResponse *requestImageResponse(const QString &id, const QSize &requestedSize) override;
 };