From 6e36396b20ac5f8d01fcfc8e71792e409ab2c547 Mon Sep 17 00:00:00 2001
From: Victor Julien <vjulien@oisf.net>
Date: Tue, 28 Nov 2023 12:22:18 +0100
Subject: [PATCH] mpm: document Search callback return value

---
 src/util-mpm.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/src/util-mpm.h b/src/util-mpm.h
index 67988efd0314..d3ac12bdec89 100644
--- a/src/util-mpm.h
+++ b/src/util-mpm.h
@@ -159,6 +159,7 @@ typedef struct MpmTableElmt_ {
     int  (*AddPattern)(struct MpmCtx_ *, uint8_t *, uint16_t, uint16_t, uint16_t, uint32_t, SigIntId, uint8_t);
     int  (*AddPatternNocase)(struct MpmCtx_ *, uint8_t *, uint16_t, uint16_t, uint16_t, uint32_t, SigIntId, uint8_t);
     int  (*Prepare)(struct MpmCtx_ *);
+    /** \retval cnt number of patterns that matches: once per pattern max. */
     uint32_t (*Search)(const struct MpmCtx_ *, struct MpmThreadCtx_ *, PrefilterRuleStore *, const uint8_t *, uint32_t);
     void (*PrintCtx)(struct MpmCtx_ *);
     void (*PrintThreadCtx)(struct MpmThreadCtx_ *);