misc: improve code documentation

Task #6383

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"

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__
 

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"

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__

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);

src/app-layer-smb.c

@@ -15,6 +15,12 @@
  * 02110-1301, USA.
  */
 
+/**
+ * \file
+ *
+ * SMB protocol handling
+ */
+
 #include "suricata-common.h"
 #include "suricata.h"
 

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__
 

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__