Update doxygen comments

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

View File

@@ -15,7 +15,9 @@
*/
class IEnrichmentService {
public:
/// @brief Virtual destructor for polymorphic cleanup.
/**
* @brief Virtual destructor for polymorphic cleanup.
*/
virtual ~IEnrichmentService() = default;
/**

View File

@@ -15,21 +15,29 @@
#include "services/logging/logger.h"
#include "web_client/web_client.h"
/// @brief Provides Wikipedia summary lookups backed by cached raw extracts.
/**
* @brief Provides Wikipedia summary lookups backed by cached raw extracts.
*/
class WikipediaEnrichmentService final : public IEnrichmentService {
public:
/// @brief Creates a new Wikipedia service with the provided web client.
/**
* @brief Creates a new Wikipedia service with the provided web client.
*/
explicit WikipediaEnrichmentService(std::unique_ptr<WebClient> client,
std::shared_ptr<ILogger> logger);
/// @brief Returns the Wikipedia-derived context for a location.
/**
* @brief Returns the Wikipedia-derived context for a location.
*/
[[nodiscard]] std::string GetLocationContext(const Location& loc) override;
private:
std::string FetchExtract(std::string_view query);
std::unique_ptr<WebClient> client_;
std::shared_ptr<ILogger> logger_;
/// @brief Canonical cache for raw Wikipedia query extracts.
/**
* @brief Canonical cache for raw Wikipedia query extracts.
*/
std::unordered_map<std::string, std::string> extract_cache_;
};