@brief -> ""

Author: refvalue

src/CMakeLists.txt

@@ -22,6 +22,16 @@ file(
     *.cpp
 )
 
+if(WIN32)
+    set(platform_suffix win32)
+elseif(APPLE)
+    set(platform_suffix macos)
+elseif(UNIX)
+    set(platform_suffix linux)
+else()
+    message(FATAL_ERROR "Unsupported platform.")
+endif()
+
 macro(es_filter_sources pattern)
     list(
         FILTER private_sources

src/argb_color.ixx

@@ -25,7 +25,7 @@ import std;
 
 export namespace essence {
     /**
-     * @brief Describes a ARGB color.
+     * Describes a ARGB color.
      */
     struct alignas(std::uint32_t) argb_color {
         std::uint8_t r{};
@@ -34,15 +34,15 @@ export namespace essence {
         std::uint8_t alpha{0xFF};
 
         /**
-         * @brief Converts a 32-bit unsigned integer.
+         * Converts a 32-bit unsigned integer.
          */
         constexpr explicit operator std::uint32_t() const noexcept {
             return (static_cast<std::uint32_t>(alpha) << 24) + (static_cast<std::uint32_t>(b) << 16)
                  + (static_cast<std::uint32_t>(g) << 8) + r;
         }
 
         /**
-         * @brief Normalizes the data to a new range.
+         * Normalizes the data to a new range.
          * @tparam T The type of the data in the new range.
          * @param min The lower bound.
          * @param max The upper bound.
@@ -67,7 +67,7 @@ export namespace essence {
     };
 
     /**
-     * @brief Constructs an ARGB color from a 32-bit unsigned integer.
+     * Constructs an ARGB color from a 32-bit unsigned integer.
      * @param color The color in a 32-bit unsigned integer.
      * @return ARGB color.
      */
@@ -81,7 +81,7 @@ export namespace essence {
     }
 
     /**
-     * @brief Common predefined colors.
+     * Common predefined colors.
      * @remark http://www.flounder.com/csharp_color_table.htm
      */
     struct argb_colors {

src/boolean.ixx

@@ -25,7 +25,7 @@ import std;
 
 export namespace essence {
     /**
-     * @brief Converts a value to a boolean with a non-boolean-convertible value to be true.
+     * Converts a value to a boolean with a non-boolean-convertible value to be true.
      * @tparam T The type of the value.
      * @param value The value.
      * @return The boolean.

src/cli/abstract/option.ixx

@@ -31,7 +31,7 @@ import std;
 
 export namespace essence::cli::abstract {
     /**
-     * @brief A CLI option, i.e. --xxx=yyy.
+     * A CLI option, i.e. --xxx=yyy.
      * @tparam T The data type of the option.
      */
     class option {

src/cli/arg_parser.ixx

@@ -34,87 +34,87 @@ import std;
 
 export namespace essence::cli {
     /**
-     * @brief A parser to handle the command line arguments.
+     * A parser to handle the command line arguments.
      */
     class arg_parser {
     public:
         using parse_result_type = abi::map<abi::string, option_result, std::less<>>;
 
         /**
-         * @brief Creates an instance.
+         * Creates an instance.
          */
         ES_API(CPPESSENCE) arg_parser();
         ES_API(CPPESSENCE) arg_parser(arg_parser&&) noexcept;
         ES_API(CPPESSENCE) ~arg_parser();
         ES_API(CPPESSENCE) arg_parser& operator=(arg_parser&&) noexcept;
 
         /**
-         * @brief Checks whether the previous parsing operation succeeds.
+         * Checks whether the previous parsing operation succeeds.
          * @return True if succeeds; otherwise false.
          */
         ES_API(CPPESSENCE) explicit operator bool() const noexcept;
 
         /**
-         * @brief Gets the added options.
+         * Gets the added options.
          * @return The added options.
          */
         [[nodiscard]] ES_API(CPPESSENCE) std::span<const abstract::option> options() const noexcept;
 
         /**
-         * @brief Gets the cached result after parsing.
+         * Gets the cached result after parsing.
          * @return The cached result as a map, or an empty map if not exists.
          */
         [[nodiscard]] ES_API(CPPESSENCE) const parse_result_type& cached_result() const noexcept;
 
         /**
-         * @brief Gets the unmatched arguments after parsing.
+         * Gets the unmatched arguments after parsing.
          * @return The unmatched arguments.
          */
         [[nodiscard]] ES_API(CPPESSENCE) std::span<const abi::string> unmatched_args() const noexcept;
 
         /**
-         * @brief Adds a new  option.
+         * Adds a new  option.
          * @param option The CLI option.
          */
         ES_API(CPPESSENCE) void add_option(abstract::option option) const; // NOLINT(*-use-nodiscard)
 
         /**
-         * @brief Parses the startup command line arguments.
+         * Parses the startup command line arguments.
          */
         ES_API(CPPESSENCE) void parse() const;
 
         /**
-         * @brief Parses the input command line arguments.
+         * Parses the input command line arguments.
          * @param argc The count of the arguments.
          * @param argv The array of the arguments.
          */
         ES_API(CPPESSENCE) void parse(std::int32_t argc, char* argv[]) const;
 
         /**
-         * @brief Parses the input command line arguments.
+         * Parses the input command line arguments.
          * @param args The arguments.
          */
         ES_API(CPPESSENCE) void parse(std::span<const abi::string> args) const;
 
         /**
-         * @brief Prints the help string.
+         * Prints the help string.
          */
         ES_API(CPPESSENCE) void show_help() const;
 
         /**
-         * @brief Subscribes an event to be invoked when an error occurs.
+         * Subscribes an event to be invoked when an error occurs.
          * @param handler The handler.
          */
         ES_API(CPPESSENCE) void on_error(const output_handler& handler) const;
 
         /**
-         * @brief Subscribes an event to be invoked when a normal output is ready.
+         * Subscribes an event to be invoked when a normal output is ready.
          * @param handler The handler.
          */
         ES_API(CPPESSENCE) void on_output(const output_handler& handler) const;
 
         /**
-         * @brief Fill a data model with the parsed result.
+         * Fill a data model with the parsed result.
          * @tparam T The type of the model.
          * @return The filled model.
          */

src/cli/common_types.ixx

@@ -25,7 +25,7 @@ import std;
 
 export namespace essence::cli {
     /**
-     * @brief A handler to provide a message to be output to the console or any other target.
+     * A handler to provide a message to be output to the console or any other target.
      */
     using output_handler = std::function<void(std::string_view message)>;
 } // namespace essence::cli

src/cli/option.ixx

@@ -34,13 +34,13 @@ import std;
 
 export namespace essence::cli {
     /**
-     * @brief Creates a base internal implementation of a CLI option class.
+     * Creates a base internal implementation of a CLI option class.
      * @return The base implementation.
      */
     ES_API(CPPESSENCE) abstract::option make_base_option();
 
     /**
-     * @brief A CLI option, i.e. --xxx=yyy.
+     * A CLI option, i.e. --xxx=yyy.
      * @tparam T The data type of the option.
      */
     template <std::default_initializable T>
@@ -58,7 +58,7 @@ export namespace essence::cli {
         static constexpr meta::fingerprint type_id{std::type_identity<T>{}};
 
         /**
-         * @brief Creates an instance.
+         * Creates an instance.
          */
         option() : base_{make_base_option()} {
             // Makes default values for an enumeration.

src/cli/option_result.ixx

@@ -28,16 +28,16 @@ import std;
 
 export namespace essence::cli {
     /**
-     * @brief The raw parsed result of a CLI option.
+     * The raw parsed result of a CLI option.
      */
     struct option_result {
         /**
-         * @brief The corresponding CLI option.
+         * The corresponding CLI option.
          */
         abstract::option option;
 
         /**
-         * @brief The raw parsed value.
+         * The raw parsed value.
          */
         std::optional<abi::string> raw_value;
     };

src/cli/validation_result.ixx

@@ -26,16 +26,16 @@ import std;
 
 export namespace essence::cli {
     /**
-     * @brief The validation result from parsing a CLI option.
+     * The validation result from parsing a CLI option.
      */
     struct validation_result {
         /**
-         * @brief Whether the validation succeeds.
+         * Whether the validation succeeds.
          */
         bool success{true};
 
         /**
-         * @brief The error message.
+         * The error message.
          */
         abi::string error;
     };

src/crypto/abstract/chunk_processor.ixx

@@ -26,7 +26,7 @@ import std;
 
 export namespace essence::crypto::abstract {
     /**
-     * @brief Provides a uniform interface for processing crypto chunks.
+     * Provides a uniform interface for processing crypto chunks.
      * @remark This interface always keeps uniquely referenced.
      */
     class chunk_processor {
@@ -36,39 +36,39 @@ export namespace essence::crypto::abstract {
         explicit chunk_processor(T&& value) : wrapper_{std::make_unique<wrapper<T>>(std::forward<T>(value))} {}
 
         /**
-         * @brief Indicates whether this is a forward transformer.
+         * Indicates whether this is a forward transformer.
          * @return True if this is a forward transformer; false if an inverse transformer.
          */
         [[nodiscard]] bool transformer() const {
             return wrapper_->transformer();
         }
 
         /**
-         * @brief Gets the name of the cipher.
+         * Gets the name of the cipher.
          * @return The name of the cipher.
          */
         [[nodiscard]] abi::string cipher_name() const {
             return wrapper_->cipher_name();
         }
 
         /**
-         * @brief Gets the size of the input buffer.
+         * Gets the size of the input buffer.
          * @return The size of the input buffer.
          */
         [[nodiscard]] std::size_t buffer_size() const {
             return wrapper_->buffer_size();
         }
 
         /**
-         * @brief Gets the extra size of the output buffer.
+         * Gets the extra size of the output buffer.
          * @return The extra size of the output buffer.
          */
         [[nodiscard]] std::size_t extra_size() const {
             return wrapper_->extra_size();
         }
 
         /**
-         * @brief Gets the factor to be multiplied to the input buffer size and the result is the size of the output
+         * Gets the factor to be multiplied to the input buffer size and the result is the size of the output
          *        buffer.
          * @return The factor described as a rational number.
          */
@@ -77,14 +77,14 @@ export namespace essence::crypto::abstract {
         }
 
         /**
-         * @brief Initializes the processor.
+         * Initializes the processor.
          */
         void init() const {
             wrapper_->init();
         }
 
         /**
-         * @brief Processes a memory chunk.
+         * Processes a memory chunk.
          * @param input The input chunk.
          * @param output The output chunk, which may be replaced with a subspan of the given span.
          */
@@ -93,7 +93,7 @@ export namespace essence::crypto::abstract {
         }
 
         /**
-         * @brief Gets the final chunk.
+         * Gets the final chunk.
          * @param output The output chunk, which may be replaced with a subspan of the given span.
          */
         void finalize(std::span<std::byte>& output) const {