SQUASH packetlib

src/util-lua-packet.c

@@ -109,6 +109,14 @@ static int LuaPacketTimestamp(lua_State *luastate)
     return 2;
 }
 
+/** \internal
+ *  \brief fill lua stack with header info
+ *  \param luastate the lua state
+ *  \retval cnt number of data items placed on the stack
+ *
+ *  Places: ipver (number), src ip (string), dst ip (string), protocol (number),
+ *          sp or icmp type (number), dp or icmp code (number).
+ */
 static int LuaPacketTuple(lua_State *luastate)
 {
     struct LuaPacket *s = (struct LuaPacket *)lua_touserdata(luastate, 1);