docs: update namespace definitions

Author: anonrig

doxygen

@@ -1017,7 +1017,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = benchmarks, tests, Testing, tools, build, docs
+EXCLUDE                = benchmarks, tests, Testing, tools, build, docs, include/ada/expected.h, singleheader, include/ada/log.h
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded

include/ada.h

@@ -1,3 +1,7 @@
+/**
+ * @file ada.h
+ * @brief Includes all definitions for Ada.
+ */
 #ifndef ADA_H
 #define ADA_H
 

include/ada/character_sets.h

@@ -10,6 +10,10 @@
 #include "ada/common_defs.h"
 #include <stdint.h>
 
+/**
+ * @namespace ada::character_sets
+ * @brief Includes the definitions for unicode character sets.
+ */
 namespace ada::character_sets {
   ada_really_inline bool bit_at(const uint8_t a[], const uint8_t i);
 } // namespace ada::character_sets

include/ada/checkers-inl.h

@@ -1,5 +1,5 @@
 /**
- * @file checkers.h
+ * @file checkers-inl.h
  * @brief Definitions for URL specific checkers used within Ada.
  */
 #ifndef ADA_CHECKERS_INL_H
@@ -23,23 +23,31 @@ namespace ada::checkers {
     if(is_little_endian) { two_first_bytes |= 0x2000; } else { two_first_bytes |= 0x020; }
     return two_first_bytes == word0x;
   }
+
   inline bool has_hex_prefix(std::string_view input) {
     return input.size() >=2 && has_hex_prefix_unsafe(input);
   }
+
   constexpr bool is_digit(char x) noexcept { return (x >= '0') & (x <= '9'); }
+
   constexpr char to_lower(char x) noexcept { return (x | 0x20); }
+
   constexpr bool is_alpha(char x) noexcept { return (to_lower(x) >= 'a') && (to_lower(x) <= 'z'); }
+
   inline constexpr bool is_windows_drive_letter(std::string_view input) noexcept {
     return input.size() >= 2 && (is_alpha(input[0]) && ((input[1] == ':') || (input[1] == '|')))
       && ((input.size() == 2) || (input[2] == '/' || input[2] == '\\' || input[2] == '?' || input[2] == '#'));
   }
+
   inline constexpr bool is_normalized_windows_drive_letter(std::string_view input) noexcept {
     return input.size() >= 2 && (is_alpha(input[0]) && (input[1] == ':'));
   }
+
   ada_really_inline constexpr bool begins_with(std::string_view view, std::string_view prefix) {
     // in C++20, you have view.begins_with(prefix)
     return view.size() >= prefix.size() && (view.substr(0, prefix.size()) == prefix);
   }
+
 } // namespace ada::checkers
 
 #endif //ADA_CHECKERS_H

include/ada/checkers.h

@@ -10,6 +10,10 @@
 #include <string_view>
 #include <cstring>
 
+/**
+ * @namespace ada::checkers
+ * @brief Includes the definitions for validation functions
+ */
 namespace ada::checkers {
 
   /**
@@ -76,7 +80,6 @@ namespace ada::checkers {
    */
   ada_really_inline constexpr uint8_t path_signature(std::string_view input) noexcept;
 
-
   /** 
    * Returns true if the length of the domain name and its labels are according to the specifications.
    * The length of the domain must be 255 octets (253 characters not including the last 2 which are the empty

include/ada/expected.h

@@ -1,3 +1,8 @@
+/**
+ * @file expected.h
+ * @brief Definitions for std::expected
+ * @private Excluded from docs through the doxygen file.
+ */
 ///
 // expected - An implementation of std::expected with extensions
 // Written in 2017 by Sy Brand (tartanllama@gmail.com, @TartanLlama)

include/ada/helpers.h

@@ -12,6 +12,10 @@
 #include <string_view>
 #include <optional>
 
+/**
+ * @namespace ada::helpers
+ * @brief Includes the definitions for helper functions
+ */
 namespace ada::helpers {
 
   /**

include/ada/implementation.h

@@ -1,6 +1,5 @@
 /**
  * @file implementation.h
- *
  * @brief Definitions for user facing functions for parsing URL and it's components.
  */
 #ifndef ADA_IMPLEMENTATION_H
@@ -29,19 +28,12 @@ namespace ada {
    * @param base_url the optional string input to use as a base url.
    * @param encoding encoding (default to UTF-8)
    * @return a parsed URL.
-   *
-   * @example
-   *
-   * ```cpp
-   * auto url = ada::url parse("https://www.google.com");
-   * ```
    */
   ada_warn_unused ada::result parse(std::string_view input,
                                  const ada::url* base_url = nullptr,
                                  ada::encoding_type encoding = ada::encoding_type::UTF8);
   /**
    * Computes a href string from a file path.
-   * @param input a path
    * @return a href string (starts with file:://)
    */
   std::string href_from_file(std::string_view path);

include/ada/log.h

@@ -1,8 +1,7 @@
-
 /**
  * @file log.h
- * @private
- * @brief logging code.
+ * @brief Includes the definitions for logging.
+ * @private Excluded from docs through the doxygen file.
  */
 #ifndef ADA_LOG_H
 #define ADA_LOG_H

include/ada/parser.h

@@ -12,6 +12,10 @@
 #include <optional>
 #include <string_view>
 
+/**
+ * @namespace ada::parser
+ * @brief Includes the definitions for supported parsers
+ */
 namespace ada::parser {
 
   /**