From 26d2b8fc86e778277041e4c0ed92efaedd9f5ff4 Mon Sep 17 00:00:00 2001
From: Alexey Sokolov <alexey+znc@asokolov.org>
Date: Fri, 2 May 2025 19:32:06 +0100
Subject: [PATCH] Add doxygen comment to CMessage::GetType()

---
 include/znc/Message.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/include/znc/Message.h b/include/znc/Message.h
index 970dc7a8..efaabcca 100644
--- a/include/znc/Message.h
+++ b/include/znc/Message.h
@@ -87,6 +87,14 @@ class CMessage {
         Topic,
         Wallops,
     };
+    /**
+     * Returns which type of message this is.
+     *
+     * This is mostly about which subclass of CMessage is intended to be used,
+     * but does not map 1:1 to the subclasses. The number is NOT guaranteed to
+     * be the same across ZNC versions. For practical purposes, GetCommand() may
+     * be more useful.
+     */
     Type GetType() const { return m_eType; }
 
     bool Equals(const CMessage& Other) const;