yyc12345/YYCCommonplace
1
0
Fork 0
Code Activity

doc: add doc for code, mainly for clap

Browse Source
This commit is contained in:
yyc12345
2025-12-23 13:59:14 +08:00
parent a077604c7d
commit cc5e6239ba
11 changed files with 361 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
src/yycc/carton/clap/summary.hpp
View File

@@ -5,8 +5,16 @@
namespace yycc::carton::clap::summary {
/// @brief Represents summary information for a command line application.
class Summary {
public:
/**
* @brief Constructs a new Summary object with the specified parameters.
* @param[in] name The name of the application
* @param[in] author The author of the application
* @param[in] version The version of the application
* @param[in] description A description of the application's purpose
*/
Summary(const std::u8string_view& name,
const std::u8string_view& author,
const std::u8string_view& version,
@@ -15,9 +23,25 @@ namespace yycc::carton::clap::summary {
YYCC_DEFAULT_COPY_MOVE(Summary)
public:
/**
* @brief Gets the name of the application.
* @return The application's name as a string view
*/
std::u8string_view get_name() const;
/**
* @brief Gets the author of the application.
* @return The application's author as a string view
*/
std::u8string_view get_author() const;
/**
* @brief Gets the version of the application.
* @return The application's version as a string view
*/
std::u8string_view get_version() const;
/**
* @brief Gets the description of the application.
* @return The application's description as a string view
*/
std::u8string_view get_description() const;
private: