From 65d919876c489baf77e3189239ffc453508c6eae Mon Sep 17 00:00:00 2001
From: James Graham <james.h.graham@protonmail.com>
Date: Fri, 5 May 2023 16:53:38 +0000
Subject: [PATCH] Document trayicon_sni

---
 src/trayicon_sni.h | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/trayicon_sni.h b/src/trayicon_sni.h
index 82f06ccab..88e5b1359 100644
--- a/src/trayicon_sni.h
+++ b/src/trayicon_sni.h
@@ -5,15 +5,32 @@
 
 #include <KStatusNotifierItem>
 
+/**
+ * @class TrayIcon
+ *
+ * A class inheriting KStatusNotifierItem to provide a tray icon.
+ *
+ * @sa KStatusNotifierItem
+ */
 class TrayIcon : public KStatusNotifierItem
 {
     Q_OBJECT
 public:
     TrayIcon(QObject *parent = nullptr);
 
+    /**
+     * @brief Show the tray icon.
+     */
     void show();
+
+    /**
+     * @brief Hide the tray icon.
+     */
     void hide();
 
 Q_SIGNALS:
+    /**
+     * @brief Triggered when the system tray icon is clicked to request NeoChat be shown.
+     */
     void showWindow();
 };