update comments

inc/header.h

@@ -10,16 +10,23 @@ Main header file.
 #define HEADER_H
 
 //////////////////////////////               Libraries                //////////////////////////////
+
 #include <stdio.h>
 #include "pico/stdlib.h"
 #include "foo.h"
 
 //////////////////////////////                Symbols                //////////////////////////////
+
 #ifndef SLEEP_TIME_MS
 #define SLEEP_TIME_MS 500
 #endif
 
 //////////////////////////////               Functions               //////////////////////////////
+
+/**
+ * @brief Test function
+ * 
+ */
 void bar(void);
 
 #endif

libs/foo/inc/foo.h

@@ -17,6 +17,10 @@ Main header file.
 
 //////////////////////////////                 Class                 //////////////////////////////
 
+/**
+ * @brief Test class
+ * 
+ */
 class foo {
 
     public:
@@ -25,13 +29,27 @@ class foo {
 
 
     //////////////////////////               Constructor             //////////////////////////
+
+    /**
+     * @brief Construct a new foo object
+     * 
+     */
     foo();
 
     //////////////////////////              Deconstructor            //////////////////////////
+
+    /**
+     * @brief Destroy the foo object
+     * 
+     */
     ~foo();
 
     //////////////////////////                Methods                //////////////////////////
 
+    /**
+     * @brief Test method
+     * 
+     */
     void bar(void);
     
 };

src/main.cpp

@@ -7,12 +7,15 @@ Main file.
 */
 
 //////////////////////////////               Libraries               //////////////////////////////
+
 #include "header.h"
 
 //////////////////////////////            Global Variable            //////////////////////////////
+
 foo baz = foo();
 
 //////////////////////////////                 Main                  //////////////////////////////
+
 int main(void) {
 
     //////////////////////////                 Setup                 //////////////////////////
@@ -46,6 +49,7 @@ int main(void) {
 }
 
 //////////////////////////////               Functions               //////////////////////////////
+
 void bar(void) {
 
      //////////////////////////                 Code                  //////////////////////////