From: Jason Ish <jason.ish@oisf.net>
Date: Tue, 22 Apr 2025 18:55:51 +0000 (-0600)
Subject: decode: documentation group for packet alert flags
X-Git-Tag: suricata-8.0.0-rc1~383
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=23c5fafe5cca764fac6a819ee7d532e5841ff7ef;p=thirdparty%2Fsuricata.git

decode: documentation group for packet alert flags

As #define's like this can't be logically grouped into an enum, try
Doxygen documentation groups, which create a group just of these flag
values and documents them together on a page.
---

diff --git a/src/decode.h b/src/decode.h
index b49359936f..b584a12b14 100644
--- a/src/decode.h
+++ b/src/decode.h
@@ -249,7 +249,14 @@ typedef struct PacketAlert_ {
     int64_t frame_id;
 } PacketAlert;
 
-/* flag to indicate the rule action (drop/pass) needs to be applied to the flow */
+/**
+ * \defgroup PacketAlertFlags
+ *
+ * Available flags for PacketAlert.flags.
+ *
+ * @{
+ */
+/** flag to indicate the rule action (drop/pass) needs to be applied to the flow */
 #define PACKET_ALERT_FLAG_APPLY_ACTION_TO_FLOW BIT_U8(0)
 /** alert was generated based on state */
 #define PACKET_ALERT_FLAG_STATE_MATCH BIT_U8(1)
@@ -265,6 +272,7 @@ typedef struct PacketAlert_ {
 #define PACKET_ALERT_FLAG_TX_GUESSED BIT_U8(6)
 /** accept should be applied to packet */
 #define PACKET_ALERT_FLAG_APPLY_ACTION_TO_PACKET BIT_U8(7)
+/** @} */
 
 extern uint16_t packet_alert_max;
 #define PACKET_ALERT_MAX 15