misc: improve code documentation

Task #6383

diff --git a/src/app-layer-dnp3.c b/src/app-layer-dnp3.c
index 21abfaaeb6dac37041094c6a16952981ee8cd03d..9501b9f5ea578f877486a6136815027ecb06d7a2 100644 (file)
--- a/src/app-layer-dnp3.c
+++ b/src/app-layer-dnp3.c
@@ -15,6 +15,12 @@
  * 02110-1301, USA.
  */
 
+/**
+ * \file
+ *
+ * DNP3 protocol implementation
+ */
+
 #include "suricata-common.h"
 #include "suricata.h"
 #include "stream.h"

diff --git a/src/app-layer-dnp3.h b/src/app-layer-dnp3.h
index 6445631d977f0d857775318720585a8c4d70e4f3..aae07f9c8095118c9d6f924800ca9bb5d582b053 100644 (file)
--- a/src/app-layer-dnp3.h
+++ b/src/app-layer-dnp3.h
@@ -15,6 +15,12 @@
  * 02110-1301, USA.
  */
 
+/**
+ * \file
+ *
+ * DNP3 application layer protocol header file
+ */
+
 #ifndef __APP_LAYER_DNP3_H__
 #define __APP_LAYER_DNP3_H__
 

diff --git a/src/app-layer-htp-libhtp.c b/src/app-layer-htp-libhtp.c
index f7daf70c92ba1fd1071cb57c5002913f065cbea1..2fbd5eae33903e337896af001a9152aa6245266f 100644 (file)
--- a/src/app-layer-htp-libhtp.c
+++ b/src/app-layer-htp-libhtp.c
@@ -36,7 +36,11 @@
  ***************************************************************************/
 
 /**
- * Anoop Saldanha <anoopsaldanha@gmail.com>
+ * \file
+ *
+ * \author Anoop Saldanha <anoopsaldanha@gmail.com>
+ *
+ * APIs from libhtp 0.5.x.
  */
 
 #include "suricata-common.h"

diff --git a/src/app-layer-htp-libhtp.h b/src/app-layer-htp-libhtp.h
index c4a3c991f74be2c7352047f24ec385524b4e148d..574dda4134dca813f7facf105c82bfc4ce155003 100644 (file)
--- a/src/app-layer-htp-libhtp.h
+++ b/src/app-layer-htp-libhtp.h
@@ -36,7 +36,11 @@
  ***************************************************************************/
 
 /**
- * Anoop Saldanha <anoopsaldanha@gmail.com>
+ * \file
+ *
+ * \author Anoop Saldanha <anoopsaldanha@gmail.com>
+ *
+ * APIs from libhtp 0.5.x.
  */
 
 #ifndef __APP_LAYER_HTP_LIBHTP__H__

diff --git a/src/app-layer-htp-mem.h b/src/app-layer-htp-mem.h
index 5df67f824d8718c1cd4705ccfaea79ced2581fa2..01cefe6750e0265b3510bcd1a0d8b2c2b09e1020 100644 (file)
--- a/src/app-layer-htp-mem.h
+++ b/src/app-layer-htp-mem.h
@@ -15,6 +15,11 @@
  * 02110-1301, USA.
  */
 
+/**
+ * \file
+ *
+ * Memory management functions for HTP in the application layer
+ */
 
 void HTPParseMemcap(void);
 void *HTPMalloc(size_t size);

diff --git a/src/app-layer-smb.c b/src/app-layer-smb.c
index e5c49d62e9c08b8af71ff47c3c057bc1a980b514..0c6102e83e5f846ad955debccbfadd914f273d14 100644 (file)
--- a/src/app-layer-smb.c
+++ b/src/app-layer-smb.c
@@ -15,6 +15,12 @@
  * 02110-1301, USA.
  */
 
+/**
+ * \file
+ *
+ * SMB protocol handling
+ */
+
 #include "suricata-common.h"
 #include "suricata.h"
 

diff --git a/src/app-layer-smb.h b/src/app-layer-smb.h
index 147f0c01a2ec7928cc54f1bf757afc6e79772fd5..39ae0411544036423ccefa3d1e30d96472372d28 100644 (file)
--- a/src/app-layer-smb.h
+++ b/src/app-layer-smb.h
@@ -15,6 +15,12 @@
  * 02110-1301, USA.
  */
 
+/**
+ * \file
+ *
+ * SMB protocol handling
+ */
+
 #ifndef __APP_LAYER_SMB_H__
 #define __APP_LAYER_SMB_H__
 

diff --git a/src/app-layer.h b/src/app-layer.h
index d08d785d73d1560ebe53ad872a573656af1ccc83..cbe2fbc9af84ba0495d4a42f0d78abfa48ba0487 100644 (file)
--- a/src/app-layer.h
+++ b/src/app-layer.h
@@ -16,8 +16,12 @@
  */
 
 /**
+ * \file
+ *
  * \author Victor Julien <victor@inliniac.net>
  * \author Anoop Saldanha <anoopsaldanha@gmail.com>
+ *
+ *  Application layer handling and protocols implementation
  */
 
 #ifndef __APP_LAYER_H__