From 6220134a483a1e57d0bae8bd3c041e018f0f3be8 Mon Sep 17 00:00:00 2001
From: Eric Leblond <eric@regit.org>
Date: Tue, 25 Oct 2011 16:29:42 +0200
Subject: [PATCH] doc: describe some features and structures.

---
 src/suricata.h | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/suricata.h b/src/suricata.h
index c6ec6d4076..ccddc651bb 100644
--- a/src/suricata.h
+++ b/src/suricata.h
@@ -38,6 +38,21 @@
  *  - \ref sigstate
  *  - \ref threshold
  *
+ * \section archi Architecture
+ *
+ * \subsection datastruct Data structures
+ *
+ * Regarding matching, there is three main data structures which are:
+ *  - ::Packet: Data relative to an individual packet with information about
+ *  linked structure such as the ::Flow the ::Packet belongs to.
+ *  - ::Flow: Information about a flow for example a TCP session
+ *  - ::StreamMsg: structure containing the reassembled data
+ *
+ *  \subsection runmode Running mode
+ *
+ *  Suricata is multithreaded and running modes define how the different
+ *  threads are working together. You can see util-runmodes.c for example
+ *  of running mode.
  */
 
 /**