yyc12345/YYCCommonplace
1
0
Fork 0
Code Activity

doc: add doxygen comment for code

Browse Source
This commit is contained in:
yyc12345
2025-12-23 21:21:34 +08:00
parent cc5e6239ba
commit 408ea5ef33
5 changed files with 156 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/yycc/carton/binstore/configuration.hpp
View File

@@ -8,14 +8,28 @@
namespace yycc::carton::binstore::configuration {
/// @brief Configuration class that holds version and settings for the binstore module.
class Configuration {
public:
/**
* @brief Construct a new Configuration object.
* @param[in] version The version identifier for this configuration.
* @param[in] settings The settings collection to associate with this configuration.
*/
Configuration(NS_YYCC_BINSTORE_TYPES::VersionIdentifier version, NS_YYCC_BINSTORE::setting::SettingCollection&& settings);
~Configuration();
YYCC_DEFAULT_COPY_MOVE(Configuration)
public:
/**
* @brief Get the version identifier of this configuration.
* @return The version identifier.
*/
NS_YYCC_BINSTORE_TYPES::VersionIdentifier get_version() const;
/**
* @brief Get the settings collection associated with this configuration.
* @return A const reference to the settings collection.
*/
const NS_YYCC_BINSTORE::setting::SettingCollection& get_settings() const;
private: