feat: linter test; fix doxygen

Author: Charliechen114514

.gitignore

@@ -12,4 +12,6 @@ out/
 
 # third_party dependencies (downloaded during configuration)
 third_party/*/
-!third_party/.gitkeep
+!third_party/.gitkeep
+
+__pycache__/

base/include/base/expected/expected.hpp

@@ -223,7 +223,12 @@ template <typename E> class unexpected {
      *
      * @throws     None if E is nothrow swappable.
      *
-     * @ingroup base_utilities
+     * @note       None.
+     *
+     * @warning    None.
+     *
+     * @since      0.1
+     * @ingroup    base_utilities
      */
     void swap(unexpected& other) noexcept(std::is_nothrow_swappable_v<E>) {
         using std::swap;
@@ -292,11 +297,44 @@ template <typename T, typename E> class expected {
                   "T must not be a reference (use T* or std::reference_wrapper)");
     static_assert(!std::is_reference_v<E>, "E must not be a reference");
 
-    /// Internal storage union.
+    /**
+     * @brief  Internal storage union for value or error.
+     *
+     * Discriminated union that holds either the value or the error.
+     * Only one member is active at any time.
+     *
+     * @note       Trivial (no explicit initialization).
+     *
+     * @warning    Direct access to members is unsafe; use has_val_ to
+     *             determine which member is active.
+     *
+     * @since      0.1
+     * @ingroup    base_utilities
+     * @internal
+     */
     union Storage {
         T val;  ///< Value storage.
+
         E err;  ///< Error storage.
+
+        /**
+         * @brief  Default constructor.
+         *
+         * @throws     None.
+         *
+         * @since      0.1
+         * @ingroup    base_utilities
+         */
         Storage() {}
+
+        /**
+         * @brief  Destructor.
+         *
+         * @throws     None.
+         *
+         * @since      0.1
+         * @ingroup    base_utilities
+         */
         ~Storage() {}
     };
 
@@ -1236,7 +1274,12 @@ template <typename T, typename E> class expected {
      *
      * @throws     None if types are nothrow move constructible and swappable.
      *
-     * @ingroup base_utilities
+     * @note       None.
+     *
+     * @warning    None.
+     *
+     * @since      0.1
+     * @ingroup    base_utilities
      */
     void swap(expected& o) noexcept(std::is_nothrow_move_constructible_v<T> &&
                                     std::is_nothrow_swappable_v<T> &&
@@ -1287,7 +1330,12 @@ template <typename T, typename E> class expected {
      *
      * @throws     None if types are nothrow move constructible and swappable.
      *
-     * @ingroup base_utilities
+     * @note       None.
+     *
+     * @warning    None.
+     *
+     * @since      0.1
+     * @ingroup    base_utilities
      */
     friend void swap(expected& a, expected& b) noexcept(noexcept(a.swap(b))) { a.swap(b); }
 };

base/include/base/hash/constexpr_fnv1a.hpp

@@ -96,6 +96,14 @@ constexpr uint64_t fnv1a64(const char* str, uint64_t seed = fnv1a64_offset_basis
  *
  * @return    64-bit hash value.
  *
+ * @throws    None.
+ *
+ * @note      This function can be evaluated at compile time if the
+ *            input is a constant expression.
+ *
+ * @warning   Different inputs may produce the same hash (collision).
+ *            Use string comparison as fallback when hashes match.
+ *
  * @since     0.1
  * @ingroup   base_hash
  */
@@ -115,6 +123,13 @@ constexpr uint64_t fnv1a64(std::string_view sv, uint64_t seed = fnv1a64_offset_b
  *
  * @return     32-bit hash value.
  *
+ * @throws     None.
+ *
+ * @note       The hash is computed at compile time for string literals.
+ *
+ * @warning    Different inputs may produce the same hash (collision).
+ *            Use string comparison as fallback when hashes match.
+ *
  * @since      0.1
  * @ingroup    base_hash
  */
@@ -132,6 +147,14 @@ constexpr uint32_t fnv1a32(const char* str, uint32_t seed = fnv1a32_offset_basis
  *
  * @return    32-bit hash value.
  *
+ * @throws    None.
+ *
+ * @note      This function can be evaluated at compile time if the
+ *            input is a constant expression.
+ *
+ * @warning   Different inputs may produce the same hash (collision).
+ *            Use string comparison as fallback when hashes match.
+ *
  * @since     0.1
  * @ingroup   base_hash
  */
@@ -148,8 +171,19 @@ constexpr uint32_t fnv1a32(std::string_view sv, uint32_t seed = fnv1a32_offset_b
  *
  * Enables syntax: `"TokenName"_hash` for compile-time hash computation.
  *
- * @since 0.1
- * @ingroup base_hash
+ * @param[in]  str Null-terminated string to hash.
+ * @param[in]  len Length of the string (unused, required by UDL syntax).
+ *
+ * @return     64-bit hash value.
+ *
+ * @throws     None.
+ *
+ * @note       This function is constexpr and evaluated at compile time.
+ *
+ * @warning    None.
+ *
+ * @since      0.1
+ * @ingroup    base_hash
  *
  * @code
  * constexpr uint64_t h = "MyToken"_hash;  // Compile-time hash

base/system/cpu/private/linux_impl/cpu_features.h

@@ -14,9 +14,17 @@
 #include <vector>
 
 /**
- * @brief Internal Windows Query for CPU features
+ * @brief Internal Linux Query for CPU features.
  *
- * @param feats Output parameter to store detected CPU feature names
- * @return cf::expected<void, cf::CPUBonusInfoViewError>
+ * @param[out] feats Output parameter to store detected CPU feature names.
+ *
+ * @throws     None (error reporting via return code if applicable).
+ *
+ * @note       None.
+ *
+ * @warning    None.
+ *
+ * @since      0.1
+ * @ingroup    system_cpu
  */
 void query_cpu_features(std::vector<std::string>& feats);

base/system/cpu/private/win_impl/cpu_features.h

@@ -14,9 +14,17 @@
 #include <vector>
 
 /**
- * @brief Internal Windows Query for CPU features
+ * @brief Internal Windows Query for CPU features.
  *
- * @param feats Output parameter to store detected CPU feature names
- * @return cf::expected<void, cf::CPUBonusInfoViewError>
+ * @param[out] feats Output parameter to store detected CPU feature names.
+ *
+ * @throws     None (error reporting via return code if applicable).
+ *
+ * @note       None.
+ *
+ * @warning    None.
+ *
+ * @since      0.1
+ * @ingroup    system_cpu
  */
 void query_cpu_features(std::vector<std::string>& feats);

base/system/memory/private/win_impl/dimm_info.h

@@ -19,7 +19,16 @@ namespace win_impl {
 /**
  * @brief Query DIMM (memory module) information using GetSystemFirmwareTable (SMBIOS).
  *
- * @param dimms Output vector to be populated with DIMM information
+ * @param[out] dimms Output vector to be populated with DIMM information.
+ *
+ * @throws     None.
+ *
+ * @note       None.
+ *
+ * @warning    None.
+ *
+ * @since      0.1
+ * @ingroup    system_memory
  */
 void queryDimmInfo(std::vector<DimmInfo>& dimms);
 

base/system/memory/private/win_impl/physical_memory.h

@@ -18,7 +18,16 @@ namespace win_impl {
 /**
  * @brief Query physical memory information using GlobalMemoryStatusEx.
  *
- * @param physical Output parameter for physical memory statistics
+ * @param[out] physical Output parameter for physical memory statistics.
+ *
+ * @throws     None.
+ *
+ * @note       None.
+ *
+ * @warning    None.
+ *
+ * @since      0.1
+ * @ingroup    system_memory
  */
 void queryPhysicalMemory(PhysicalMemory& physical);
 

base/system/memory/private/win_impl/process_memory.h

@@ -18,7 +18,16 @@ namespace win_impl {
 /**
  * @brief Query current process memory usage using GetProcessMemoryInfo.
  *
- * @param process Output parameter for process memory statistics
+ * @param[out] process Output parameter for process memory statistics.
+ *
+ * @throws     None.
+ *
+ * @note       None.
+ *
+ * @warning    None.
+ *
+ * @since      0.1
+ * @ingroup    system_memory
  */
 void queryProcessMemory(ProcessMemory& process);
 

base/system/memory/private/win_impl/swap_memory.h

@@ -18,7 +18,16 @@ namespace win_impl {
 /**
  * @brief Query swap space information using GlobalMemoryStatusEx.
  *
- * @param swap Output parameter for swap space statistics
+ * @param[out] swap Output parameter for swap space statistics.
+ *
+ * @throws     None.
+ *
+ * @note       None.
+ *
+ * @warning    None.
+ *
+ * @since      0.1
+ * @ingroup    system_memory
  */
 void querySwapMemory(SwapMemory& swap);
 

document/.gitignore

@@ -1,3 +1,2 @@
 # AI Helpers lol
-DOXYGEN_REQUEST.md
 TODO.md