From 3b1558946dff9e0466910273c2588e3071d19cb5 Mon Sep 17 00:00:00 2001 From: Liza Opar Date: Thu, 12 Oct 2023 14:07:48 +0300 Subject: [PATCH] misc: improve code documentation Task #6383 --- src/app-layer-dnp3.c | 6 ++++++ src/app-layer-dnp3.h | 6 ++++++ src/app-layer-htp-libhtp.c | 6 +++++- src/app-layer-htp-libhtp.h | 6 +++++- src/app-layer-htp-mem.h | 5 +++++ src/app-layer-smb.c | 6 ++++++ src/app-layer-smb.h | 6 ++++++ src/app-layer.h | 4 ++++ 8 files changed, 43 insertions(+), 2 deletions(-) diff --git a/src/app-layer-dnp3.c b/src/app-layer-dnp3.c index 21abfaaeb6..9501b9f5ea 100644 --- 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 6445631d97..aae07f9c80 100644 --- 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 f7daf70c92..2fbd5eae33 100644 --- a/src/app-layer-htp-libhtp.c +++ b/src/app-layer-htp-libhtp.c @@ -36,7 +36,11 @@ ***************************************************************************/ /** - * Anoop Saldanha + * \file + * + * \author Anoop Saldanha + * + * 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 c4a3c991f7..574dda4134 100644 --- a/src/app-layer-htp-libhtp.h +++ b/src/app-layer-htp-libhtp.h @@ -36,7 +36,11 @@ ***************************************************************************/ /** - * Anoop Saldanha + * \file + * + * \author Anoop Saldanha + * + * 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 5df67f824d..01cefe6750 100644 --- 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 e5c49d62e9..0c6102e83e 100644 --- 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 147f0c01a2..39ae041154 100644 --- 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 d08d785d73..cbe2fbc9af 100644 --- a/src/app-layer.h +++ b/src/app-layer.h @@ -16,8 +16,12 @@ */ /** + * \file + * * \author Victor Julien * \author Anoop Saldanha + * + * Application layer handling and protocols implementation */ #ifndef __APP_LAYER_H__ -- 2.47.2