flow: document FlowBypassedTimeout

Main point is to document it is interacting with the capture
layer.

diff --git a/src/flow-manager.c b/src/flow-manager.c
index 40654f813ef10ee22f76c81956bd9b622b6b6e18..2abc8c817f22fe588da241babce717801a7f501d 100644 (file)
--- a/src/flow-manager.c
+++ b/src/flow-manager.c
@@ -208,6 +208,16 @@ static int FlowManagerFlowTimeout(Flow *f, struct timeval *ts, int32_t *next_ts,
     return 1;
 }
 
+/** \internal
+ *  \brief check timeout of captured bypassed flow by querying capture method
+ *
+ *  \param f Flow
+ *  \param ts timestamp
+ *  \param counters Flow timeout counters
+ *
+ *  \retval 0 not timeout
+ *  \retval 1 timeout (or not capture bypassed)
+ */
 static inline int FlowBypassedTimeout(Flow *f, struct timeval *ts,
                                       FlowTimeoutCounters *counters)
 {