Better Documentation

Doxyfile

@@ -524,7 +524,7 @@ TIMESTAMP              = NO
 # normally produced when WARNINGS is set to YES.
 # The default value is: NO.
 
-EXTRACT_ALL            = NO
+EXTRACT_ALL            = YES
 
 # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
 # be included in the documentation.
@@ -548,7 +548,7 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
+EXTRACT_STATIC         = YES
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,
@@ -588,7 +588,7 @@ RESOLVE_UNNAMED_PARAMS = YES
 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
 # The default value is: NO.
 
-HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_MEMBERS     = YES
 
 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
 # undocumented classes that are normally visible in the class hierarchy. If set

include/helpers/stringhelpers.h

@@ -57,8 +57,8 @@ namespace Nickvision::Helpers::StringHelpers
     /**
      * @brief Concatenates the elements of a string list using the specified separator between each element.
      * @param values The list of strings to join
-     * @param delimiter The string to use as a separator between each element
-     * @param delimitLast Whether or not to include the separator for the last joined element
+     * @param separator The string to use as a separator between each element
+     * @param separateLast Whether or not to include the separator for the last joined element
      * @return A single string that consists of all elements of the string list separated by the delimiter
      */
     std::string join(const std::vector<std::string>& values, const std::string& separator, bool separateLast = true);
@@ -76,7 +76,7 @@ namespace Nickvision::Helpers::StringHelpers
     /**
      * @brief Replaces a substring within a string with a new string.
      * @param s The string to work on
-     * @param toRepalce The substring to be replaced
+     * @param toReplace The substring to be replaced
      * @param replace The new string to replace with
      * @return The new replaced string
      */

include/keyring/systemcredentials.h

@@ -46,7 +46,7 @@ namespace Nickvision::Keyring::SystemCredentials
      * @brief On Linux, only the name and password of a credential will be stored. 
      * @brief On Windows, all fields of a credential will be stored.
      * @brief On macOS, all fields of a credential will be stored.
-     * @param name The new credential object
+     * @param credential The new credential object
      * @return True if successful, else false
      */
     bool addCredential(const Credential& credential);
@@ -55,7 +55,7 @@ namespace Nickvision::Keyring::SystemCredentials
      * @brief On Linux, only the name and password of a credential will be stored. 
      * @brief On Windows, all fields of a credential will be stored.
      * @brief On macOS, all fields of a credential will be stored.
-     * @param name The updated credential object
+     * @param credential The updated credential object
      * @return True if successful, else false
      */
     bool updateCredential(const Credential& credential);

include/system/environment.h

@@ -20,13 +20,13 @@
  * Functions for working with the system's shell and environment.
  */
 
+#ifndef ENVIRONMENT_H
+#define ENVIRONMENT_H
+
 #if (defined(_WIN32) && !defined(_CRT_SECURE_NO_WARNINGS))
 #define _CRT_SECURE_NO_WARNINGS
 #endif
 
-#ifndef ENVIRONMENT_H
-#define ENVIRONMENT_H
-
 #include <filesystem>
 #include <string>
 #include <vector>