From c83c9bd7658737bd56b205753558bbf583450343 Mon Sep 17 00:00:00 2001 From: Michele Bigi Date: Mon, 6 Jul 2026 16:17:43 +0200 Subject: [PATCH] Document FrequencyKHz strong type in the class reference manual. Co-authored-by: Cursor --- Software/docs/manual/ch-classes.tex | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/Software/docs/manual/ch-classes.tex b/Software/docs/manual/ch-classes.tex index 1a259cf..ae82a99 100644 --- a/Software/docs/manual/ch-classes.tex +++ b/Software/docs/manual/ch-classes.tex @@ -30,6 +30,11 @@ Used by \texttt{HealthStatus} and the \texttt{/api/health} endpoint so version strings are never passed as bare \texttt{char*} across module boundaries. Invariant: non-empty at construction. +\section{FrequencyKHz}\label{cls:FrequencyKHz} +Validated FM centre frequency in kilohertz (64\,000–108\,000). Parsed once +from JSON at the HTTP boundary via \texttt{FrequencyKHz::tryFromKhz()}; +trusted downstream by \texttt{ITuner}, \texttt{Si4684Driver}, and status DTOs. + \section{HealthStatus}\label{cls:HealthStatus} Immutable health-check DTO returned by \texttt{GET /api/health}. Built via \texttt{HealthStatus::ok(FirmwareVersion)} in the pure core; JSON