documentation updates, remove superfluous comments

This commit is contained in:
Aaron Po
2026-06-23 01:04:46 -04:00
parent e590cf2543
commit 35a5c0785c
21 changed files with 44 additions and 95 deletions

View File

@@ -16,10 +16,6 @@
class IExportService {
public:
IExportService() = default;
/**
* @brief Virtual destructor for polymorphic cleanup.
*/
virtual ~IExportService() = default;
IExportService(const IExportService&) = delete;

View File

@@ -109,6 +109,8 @@ INSERT INTO users (
) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?);
)sql";
// sqlite3_bind_*() parameter indices are 1-based, matching the "?"
// placeholder order in the SQL above.
inline constexpr int kLocationCityBindIndex = 1;
inline constexpr int kLocationStateProvinceBindIndex = 2;
inline constexpr int kLocationIso31662BindIndex = 3;

View File

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

View File

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

View File

@@ -1,13 +1,18 @@
//
// Created by aaronpo on 13/05/2026.
//
#ifndef BIERGARTEN_PIPELINE_INCLUDES_SERVICES_ENRICHMENT_MOCK_ENRICHMENT_H_
#define BIERGARTEN_PIPELINE_INCLUDES_SERVICES_ENRICHMENT_MOCK_ENRICHMENT_H_
/**
* @file services/enrichment/mock_enrichment.h
* @brief No-op IEnrichmentService used when network enrichment is disabled.
*/
#include <string>
#include "enrichment_service.h"
/**
* @brief Enrichment service that returns no context for any location.
*/
class MockEnrichmentService final : public IEnrichmentService {
public:
std::string GetLocationContext(const Location& /*loc*/) override {

View File

@@ -36,7 +36,11 @@ class WikipediaEnrichmentService final : public IEnrichmentService {
std::unique_ptr<WebClient> client_;
std::shared_ptr<ILogger> logger_;
/**
* @brief Canonical cache for raw Wikipedia query extracts.
* @brief Cache for raw Wikipedia query extracts, keyed by query string.
*
* GetLocationContext() always queries "brewing" and reuses "beer in
* {country}" for every city in that country, so caching avoids refetching
* the same extract across locations in a run.
*/
std::unordered_map<std::string, std::string> extract_cache_;
};