From c9c269f8eb0e0d2909c841377e18a0d400482fb9 Mon Sep 17 00:00:00 2001
From: Florian Hoss <flhoit00@hs-esslingen.de>
Date: Sat, 30 Jul 2022 11:14:45 +0200
Subject: [PATCH] Write doxygen comments for Utils

---
 src/Utils.hpp | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/src/Utils.hpp b/src/Utils.hpp
index 2604b8b..8cc9de6 100644
--- a/src/Utils.hpp
+++ b/src/Utils.hpp
@@ -33,6 +33,11 @@ namespace fw
     } auth_t;
 
     static const uint8_t IPV4ADDRESS_LENGTH = 16;
+
+    /**
+     * @brief the typedef to describe a Firewall rule
+     *
+     */
     typedef struct firewall_rules
     {
         uint8_t key;
@@ -44,6 +49,10 @@ namespace fw
         struct firewall_rules *next;
     } firewall_rule_t;
 
+    /**
+     * @brief the typedef to describe a network packet
+     *
+     */
     typedef struct my_packet
     {
         char ip[IPV4ADDRESS_LENGTH];
@@ -64,12 +73,21 @@ namespace fw
     } firewall_fields_t;
 
     static const uint8_t CREDENTIALS_LENGTH = 32;
+
+    /**
+     * @brief the typedef to describe credentials of the API
+     *
+     */
     typedef struct credentials
     {
         char password[CREDENTIALS_LENGTH];
         char username[CREDENTIALS_LENGTH];
     } credential_t;
 
+    /**
+     * @brief the typedef to describe an API endpoint
+     *
+     */
     typedef struct api_endpoints
     {
         char uri[60];