From f453334f63a1b169d207139aec83f70a0dc616a2 Mon Sep 17 00:00:00 2001
From: James Graham <james.h.graham@protonmail.com>
Date: Wed, 3 May 2023 20:11:23 +0100
Subject: [PATCH] Document trayicon

---
 src/trayicon.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/trayicon.h b/src/trayicon.h
index 0a08bb431..1f1844989 100644
--- a/src/trayicon.h
+++ b/src/trayicon.h
@@ -7,6 +7,15 @@
 
 #include <QSystemTrayIcon>
 
+/**
+ * @class TrayIcon
+ *
+ * A class inheriting from QSystemTrayIcon to handle setting the system tray icon.
+ *
+ * Works for Windows, Linux and MacOS.
+ *
+ * @sa QSystemTrayIcon
+ */
 class TrayIcon : public QSystemTrayIcon
 {
     Q_OBJECT
@@ -14,5 +23,8 @@ public:
     TrayIcon(QObject *parent = nullptr);
 
 Q_SIGNALS:
+    /**
+     * @brief Triggered when the system tray icon is clicked to request NeoChat be shown.
+     */
     void showWindow();
 };