Added javadoc comments to staff functions

Doxyfile

@@ -991,7 +991,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = src/ include/
+INPUT                  = src/
 
 # This tag can be used to specify the character encoding of the source files
 # that Doxygen parses. Internally Doxygen uses the UTF-8 encoding. Doxygen uses
@@ -2353,7 +2353,7 @@ MAN_LINKS              = NO
 # captures the structure of the code including all documentation.
 # The default value is: NO.
 
-GENERATE_XML           = YES
+GENERATE_XML           = NO
 
 # The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -2387,7 +2387,7 @@ XML_NS_MEMB_FILE_SCOPE = NO
 # that can be used to generate PDF.
 # The default value is: NO.
 
-GENERATE_DOCBOOK       = YES
+GENERATE_DOCBOOK       = NO
 
 # The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be put in

include/staffFunctions.h

@@ -1,4 +1,17 @@
 #pragma once
 
+/**
+ * @brief Used to increase the maximum staff volume
+ *
+ * @param maxVolume Pointer to the variable used to keep track of staff volume
+ */
 void staffVolumeUp(int *maxVolume);
+
+/**
+ * @brief Used to decrease the maximum staff volume. If the max volume is set lower than what the current user volume is, then the user volume will also be lowered.
+ *
+ * @param maxVolume Variable used to keep track of the max volume
+ * @param userVolume Pointer to the variable used to keep track of the user volume
+ * @param oldUserVolume Pointer to the variable used to keep track of the user volume when in mute or lowered
+ */
 void staffVolumeDown(int maxVolume, int *userVolume, int *oldUserVolume);

src/staffFunctions.cpp

@@ -1,7 +1,23 @@
+/**
+ * @file staffFunctions.cpp
+ * @author Lyubomir Penev
+ * @brief Here are all the implementations of the staff functions
+ * @version 1.0
+ * @date 2025-10-23
+ *
+ * @copyright Copyright (c) 2025
+ *
+ */
+
 #include <staffFunctions.h>
 #include <constants.h>
 #include <potControlls.h>
 
+/**
+ * @brief Used to increase the maximum staff volume
+ * 
+ * @param maxVolume Pointer to the variable used to keep track of staff volume
+ */
 void staffVolumeUp(int *maxVolume)
 {
     if (*maxVolume < 64)
@@ -10,6 +26,13 @@ void staffVolumeUp(int *maxVolume)
     }
 }
 
+/**
+ * @brief Used to decrease the maximum staff volume. If the max volume is set lower than what the current user volume is, then the user volume will also be lowered.
+ * 
+ * @param maxVolume Variable used to keep track of the max volume
+ * @param userVolume Pointer to the variable used to keep track of the user volume
+ * @param oldUserVolume Pointer to the variable used to keep track of the user volume when in mute or lowered
+ */
 void staffVolumeDown(int maxVolume, int *userVolume, int *oldUserVolume)
 {
     if (maxVolume > STAFF_STEPS)