AaronPo/the-biergarten-app
1
0
Fork 0
mirror of https://github.com/aaronpo97/the-biergarten-app.git synced 2026-07-16 17:47:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update doxygen comments

Browse Source
This commit is contained in:
Aaron Po
2026-06-23 00:45:32 -04:00
parent 22b3f2b3f9
commit 8d6b83673b
12 changed files with 269 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
tooling/pipeline/includes/data_model/generated_models.h
View File

@@ -19,16 +19,24 @@
* @brief Generated brewery payload.
*/
struct BreweryResult {
/// @brief Brewery display name in English.
/**
* @brief Brewery display name in English.
*/
std::string name_en;
/// @brief Brewery description text in English.
/**
* @brief Brewery description text in English.
*/
std::string description_en;
/// @brief Brewery display name in the local language.
/**
* @brief Brewery display name in the local language.
*/
std::string name_local;
/// @brief Brewery description text in the local language.
/**
* @brief Brewery description text in the local language.
*/
std::string description_local;
};
@@ -36,26 +44,38 @@ struct BreweryResult {
* @brief Generated user profile payload.
*/
struct UserResult {
/// @brief First (given) name, copied from the sampled Name -- not
/// LLM-invented.
/**
* @brief First (given) name, copied from the sampled Name -- not
* LLM-invented.
*/
std::string first_name{};
/// @brief Last (family) name, copied from the sampled Name -- not
/// LLM-invented.
/**
* @brief Last (family) name, copied from the sampled Name -- not
* LLM-invented.
*/
std::string last_name{};
/// @brief Gender associated with the sampled first name, copied from the
/// sampled Name -- not LLM-invented.
/**
* @brief Gender associated with the sampled first name, copied from the
* sampled Name -- not LLM-invented.
*/
std::string gender{};
/// @brief Username handle.
/**
* @brief Username handle.
*/
std::string username{};
/// @brief Short user biography.
/**
* @brief Short user biography.
*/
std::string bio{};
/// @brief Relative check-in/activity weight for this user, used to drive
/// a J-curve activity profile in later pipeline phases.
/**
* @brief Relative check-in/activity weight for this user, used to drive
* a J-curve activity profile in later pipeline phases.
*/
float activity_weight{};
};