From 6438977964e123c4c73de7f365c2fc5923564b21 Mon Sep 17 00:00:00 2001
From: James Graham <james.h.graham@protonmail.com>
Date: Sat, 15 Apr 2023 08:46:45 +0000
Subject: [PATCH] Document messagefiltermodel

---
 src/models/messagefiltermodel.h | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/models/messagefiltermodel.h b/src/models/messagefiltermodel.h
index 02ac34942..ae85371ca 100644
--- a/src/models/messagefiltermodel.h
+++ b/src/models/messagefiltermodel.h
@@ -5,10 +5,21 @@
 
 #include <QSortFilterProxyModel>
 
+/**
+ * @class MessageFilterModel
+ *
+ * This model filters out any messages that should be hidden.
+ *
+ * Deleted messages are only hidden if the user hasn't set them to be shown.
+ */
 class MessageFilterModel : public QSortFilterProxyModel
 {
     Q_OBJECT
 public:
     MessageFilterModel(QObject *parent = nullptr);
+
+    /**
+     * @brief Custom filter function to remove hidden messages.
+     */
     bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override;
 };