Update doxygen comments

tooling/pipeline/includes/data_model/generated_models.h

@@ -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{};
 };
 

tooling/pipeline/includes/data_model/models.h

@@ -28,28 +28,44 @@ namespace prog_opts = boost::program_options;
  * @brief Canonical location record for city-level generation.
  */
 struct Location {
-  /// @brief City name.
+  /**
+   * @brief City name.
+   */
   std::string city{};
 
-  /// @brief State or province name.
+  /**
+   * @brief State or province name.
+   */
   std::string state_province{};
 
-  /// @brief ISO 3166-2 subdivision code.
+  /**
+   * @brief ISO 3166-2 subdivision code.
+   */
   std::string iso3166_2{};
 
-  /// @brief Country name.
+  /**
+   * @brief Country name.
+   */
   std::string country{};
 
-  /// @brief ISO 3166-1 country code.
+  /**
+   * @brief ISO 3166-1 country code.
+   */
   std::string iso3166_1{};
 
-  /// @brief Local language codes in priority order.
+  /**
+   * @brief Local language codes in priority order.
+   */
   std::vector<std::string> local_languages{};
 
-  /// @brief Latitude in decimal degrees.
+  /**
+   * @brief Latitude in decimal degrees.
+   */
   double latitude{};
 
-  /// @brief Longitude in decimal degrees.
+  /**
+   * @brief Longitude in decimal degrees.
+   */
   double longitude{};
 };
 
@@ -63,14 +79,20 @@ struct Location {
  * Produced by NamesByCountry::SampleName();
  */
 struct Name {
-  /// @brief First (given) name.
+  /**
+   * @brief First (given) name.
+   */
   std::string first_name{};
 
-  /// @brief Last (family) name.
+  /**
+   * @brief Last (family) name.
+   */
   std::string last_name{};
 
-  /// @brief Gender associated with the sampled forename (e.g. "M", "F"), as
-  /// reported by the source dataset.
+  /**
+   * @brief Gender associated with the sampled forename (e.g. "M", "F"), as
+   * reported by the source dataset.
+   */
   std::string gender{};
 };
 
@@ -78,11 +100,15 @@ struct Name {
  * @brief A single forename entry from the names-by-country fixture data.
  */
 struct ForenameEntry {
-  /// @brief Romanized forename.
+  /**
+   * @brief Romanized forename.
+   */
   std::string name{};
 
-  /// @brief Gender associated with this forename, as reported by the source
-  /// dataset (e.g. "M", "F").
+  /**
+   * @brief Gender associated with this forename, as reported by the source
+   * dataset (e.g. "M", "F").
+   */
   std::string gender{};
 };
 
@@ -90,13 +116,19 @@ struct ForenameEntry {
  * @brief A persona archetype used to ground LLM-generated user bios.
  */
 struct UserPersona {
-  /// @brief Persona display name (e.g. "Hophead Explorer").
+  /**
+   * @brief Persona display name (e.g. "Hophead Explorer").
+   */
   std::string name{};
 
-  /// @brief Short description of the persona's interests and voice.
+  /**
+   * @brief Short description of the persona's interests and voice.
+   */
   std::string description{};
 
-  /// @brief Beer styles this persona gravitates toward.
+  /**
+   * @brief Beer styles this persona gravitates toward.
+   */
   std::vector<std::string> style_affinities{};
 };
 
@@ -108,22 +140,34 @@ struct UserPersona {
  * @brief LLM sampling parameters.
  */
 struct SamplingOptions {
-  /// @brief LLM sampling temperature (higher = more random).
+  /**
+   * @brief LLM sampling temperature (higher = more random).
+   */
   float temperature = 1.0F;
 
-  /// @brief LLM nucleus sampling top-p parameter.
+  /**
+   * @brief LLM nucleus sampling top-p parameter.
+   */
   float top_p = 0.95F;
 
-  /// @brief LLM top-k sampling parameter.
+  /**
+   * @brief LLM top-k sampling parameter.
+   */
   uint32_t top_k = 64;
 
-  /// @brief Context window size (tokens).
+  /**
+   * @brief Context window size (tokens).
+   */
   uint32_t n_ctx = 8192;
 
-  /// @brief Random seed (-1 for random, otherwise non-negative).
+  /**
+   * @brief Random seed (-1 for random, otherwise non-negative).
+   */
   int seed = -1;
 
-  /// @brief Number of layers to offload to GPU.
+  /**
+   * @brief Number of layers to offload to GPU.
+   */
   int n_gpu_layers = 0;
 };
 
@@ -131,14 +175,20 @@ struct SamplingOptions {
  * @brief Configuration for the LLM generator component.
  */
 struct GeneratorOptions {
-  /// @brief Path to the LLM model file (gguf format).
+  /**
+   * @brief Path to the LLM model file (gguf format).
+   */
   std::filesystem::path model_path;
 
-  /// @brief Use mocked generator instead of actual LLM inference.
+  /**
+   * @brief Use mocked generator instead of actual LLM inference.
+   */
   bool use_mocked = false;
 
-  /// @brief Specific sampling parameters for this generator.
-  /// If nullopt, the application should use global defaults.
+  /**
+   * @brief Specific sampling parameters for this generator.
+   * If nullopt, the application should use global defaults.
+   */
   std::optional<SamplingOptions> sampling;
 };
 
@@ -146,18 +196,26 @@ struct GeneratorOptions {
  * @brief Configuration for the pipeline execution and output.
  */
 struct PipelineOptions {
-  /// @brief Directory for generated artifacts.
+  /**
+   * @brief Directory for generated artifacts.
+   */
   std::filesystem::path output_path;
 
-  /// @brief Directory that contains named prompt files (e.g.
-  /// BREWERY_GENERATION.md).
+  /**
+   * @brief Directory that contains named prompt files (e.g.
+   * BREWERY_GENERATION.md).
+   */
   std::filesystem::path prompt_dir;
 
-  /// @brief Path for application logs.
+  /**
+   * @brief Path for application logs.
+   */
   std::filesystem::path log_path;
 
-  /// @brief Number of locations to sample from the dataset
-  /// More locations -> more users/more breweries
+  /**
+   * @brief Number of locations to sample from the dataset
+   * More locations -> more users/more breweries
+   */
   uint32_t location_count;
 };