📝 Add docstrings to main

docs/doxygen-awesome-css/doxygen-awesome-tabs.js

@@ -66,6 +66,13 @@ class DoxygenAwesomeTabs {
                 tabsOverviewContainer.appendChild(tabsOverview)
                 tabbed.before(tabsOverviewContainer)
 
+                /**
+                 * Adjusts the height of the tabbed container to fit the tallest tab.
+                 *
+                 * Iterates through each <code>li</code> element within the <code>tabbed</code> container, temporarily setting
+                 * its display to "block" to accurately measure its height, then restoring its original display style. The container's
+                 * height is updated to the maximum tab height plus an extra 10 pixels for padding.
+                 */
                 function resize() {
                     let maxTabHeight = 0
                     tabbed.querySelectorAll("li").forEach((tab, tabIndex) => {

docs/doxygen-awesome-css/doxygen-custom/toggle-alternative-theme.js

@@ -1,6 +1,12 @@
-
 let original_theme_active = true;
 
+/**
+ * Toggles between the original and alternative themes.
+ *
+ * When the original theme is active, this function enables the alternative theme by adding the "alternative" class
+ * to the document's root element and updates the state flag accordingly. If the alternative theme is active, it removes
+ * the class and resets the state to reflect that the original theme is in use.
+ */
 function toggle_alternative_theme() {
     if(original_theme_active) {
         document.documentElement.classList.add("alternative")

docs/doxygen-awesome-css/include/MyLibrary/subclass-example.hpp

@@ -34,6 +34,29 @@ namespace MyLibrary {
          * @param parameter3 third parameter
          */
         template <typename T, typename Foo, typename Bar, typename Alice, typename Bob, typename Charlie, typename Hello, typename World>
+        /**
+         * @brief Processes multiple inputs and conditionally outputs a console message.
+         *
+         * This function accepts a mix of shared pointers, a flag for conditional behavior,
+         * and additional parameters of various types. It demonstrates handling of multiple
+         * template arguments and parameters by outputting a message to the console. The function
+         * is intended to return a pair of strings that represent processed results.
+         *
+         * @tparam T The type associated with the first shared pointer.
+         * @tparam Foo Unused template parameter.
+         * @tparam Bar Unused template parameter.
+         * @tparam Alice The type of the fourth parameter.
+         * @tparam Bob The type of the fifth parameter.
+         * @tparam Charlie Unused template parameter.
+         * @tparam Hello Unused template parameter.
+         * @tparam World Unused template parameter.
+         * @param param1 A shared pointer to an object of type T.
+         * @param param2 A shared pointer to a string used as input.
+         * @param parameter3 A boolean flag influencing the function's conditional logic.
+         * @param paramater4 An additional input parameter of type Alice.
+         * @param parameter5 An additional input parameter of type Bob.
+         * @return A pair of strings representing the processed results.
+         */
         std::pair<std::string, std::string> long_function_with_many_parameters(std::shared_ptr<T>& param1, std::shared_ptr<std::string>& param2, bool parameter3, Alice paramater4 Bob parameter 5) {
             if(true) {
                 std::cout << "this even has some code." << std::endl;

entry/entry_c.c

@@ -30,6 +30,13 @@ static void zeroBss(void);
  **/
 static void copyData(void);
 
+/**
+ * @brief Initializes memory sections and transfers control to the main function.
+ *
+ * This function zeros out the BSS section and copies the initialized data from ROM to RAM,
+ * setting up the runtime environment before calling the externally defined main function.
+ * It is marked with the `used` attribute to ensure it is retained by the linker.
+ */
 __attribute__((used)) void entry_c(void)
 {
     zeroBss();
@@ -44,6 +51,13 @@ __attribute__((used)) void entry_c(void)
     /* { */
     /* } */
 }
+/**
+ * @brief Zeros out the BSS memory section.
+ *
+ * This function iterates from the start of the BSS section (__bss_start__) to its end (__bss_end__)
+ * and sets each 32-bit word to zero. It ensures that all uninitialized global and static variables
+ * in the BSS segment are cleared before the application's main function is executed.
+ */
 static void zeroBss(void)
 {
     // Symbol is located on start of BSS Section
@@ -58,6 +72,13 @@ static void zeroBss(void)
     }
 }
 
+/**
+ * @brief Copies initialized data from Flash memory to RAM.
+ *
+ * This function copies each 32-bit word from the source data section in Flash,
+ * starting at `__data_start_rom__`, to the destination data section in RAM,
+ * spanning from `__data_start__` (inclusive) to `__data_end__` (exclusive).
+ */
 static void copyData(void)
 {
     // Symbol is located on start of Data Section

helper-scripts/convert_to_array.sh

@@ -5,6 +5,17 @@
 BOLD=$'\033[1m'
 RESET=$'\033[0m'
 
+# Displays usage instructions for the ASCII art conversion script.
+#
+# Globals:
+#   BOLD   - Terminal code for bold text formatting.
+#   RESET  - Terminal code to reset text formatting.
+#
+# Outputs:
+#   Prints a detailed usage message, including command syntax, an example command, and sample input/output.
+#
+# Example:
+#   usage
 usage() {
   cat <<EOF
 ${BOLD}Usage: ./convert_ascii.sh input.txt [ARRAY_NAME] [desired_width]${RESET}

helper-scripts/convert_to_string.sh

@@ -5,6 +5,18 @@
 BOLD=$'\033[1m'
 RESET=$'\033[0m'
 
+# Displays usage instructions for the ASCII art conversion script.
+#
+# Globals:
+#   BOLD   - Terminal escape sequence for bold text formatting.
+#   RESET  - Terminal escape sequence to reset formatting.
+#
+# Outputs:
+#   Prints a multi-line message to STDOUT detailing how to run the script, including the
+#   required arguments, an example invocation, and the expected C-style string output format.
+#
+# Example:
+#   $ usage
 usage() {
   cat <<EOF
 ${BOLD}Usage: ./convert_ascii.sh input.txt [VARIABLE_NAME]${RESET}