refactor: remove design references from mqtt-connector doc comments

Author: test

aimdb-mqtt-connector/src/embassy_client.rs

@@ -297,9 +297,9 @@ unsafe impl Sync for TlsSlot {}
 ///
 /// Collects routes from the database during `build()` and wires the broker
 /// manager + the outbound/inbound pumps. The broker URL scheme selects the
-/// transport (design 044 D9): `mqtt://` is plain TCP (default port 1883),
-/// `mqtts://` is TLS (default port 8883) and requires both the `embassy-tls`
-/// feature and [`with_tls`](Self::with_tls).
+/// transport: `mqtt://` is plain TCP (default port 1883), `mqtts://` is TLS
+/// (default port 8883) and requires both the `embassy-tls` feature and
+/// [`with_tls`](Self::with_tls).
 pub struct MqttConnectorBuilder {
     broker_url: String,
     client_id: String,
@@ -351,7 +351,7 @@ impl MqttConnectorBuilder {
         self
     }
 
-    /// Provide the TLS materials for an `mqtts://` broker (design 044 §4).
+    /// Provide the TLS materials for an `mqtts://` broker.
     ///
     /// Required for `mqtts://` URLs; rejected at `build()` for `mqtt://`.
     #[cfg(feature = "embassy-tls")]
@@ -393,7 +393,7 @@ impl ConnectorBuilder for MqttConnectorBuilder {
                 static_connection_settings(&self.client_id, self.credentials.as_ref());
 
             // Broker manager task(s) + the channel ends for the pumps.
-            // The URL scheme selects the transport (design 044 D9).
+            // The URL scheme selects the transport.
             #[cfg(feature = "embassy-tls")]
             let (action_sender, event_receiver, manager_tasks) = {
                 let tls_options = self.tls.0.borrow_mut().take();
@@ -454,7 +454,7 @@ impl ConnectorBuilder for MqttConnectorBuilder {
     }
 }
 
-/// Parsed broker endpoint: transport + authority (design 044 D9).
+/// Parsed broker endpoint: transport + authority.
 struct BrokerUrl {
     tls: bool,
     host: String,
@@ -597,8 +597,8 @@ fn setup_manager(
 }
 
 /// Set up the TLS broker manager ([`run_tls`]) plus the SNTP time-source
-/// task (design 044 §5–§6). Synchronous — no `.await` — so the caller's
-/// `build` future stays `Send`.
+/// task. Synchronous — no `.await` — so the caller's `build` future stays
+/// `Send`.
 #[cfg(feature = "embassy-tls")]
 fn setup_tls_manager(
     broker: &BrokerUrl,
@@ -616,7 +616,7 @@ fn setup_tls_manager(
     let (action_sender, action_receiver, event_sender, event_receiver) = init_channels();
 
     // `Settings` supplies the session cadence and port; its address field is
-    // unused on the TLS path (the host is resolved per attempt, 044 D7).
+    // unused on the TLS path (the host is resolved per attempt instead).
     let settings = Settings::new(Ipv4Address::UNSPECIFIED, broker.port);
     let network = stack.get();
     let host = broker.host.clone();

aimdb-mqtt-connector/src/embassy_tls.rs

@@ -1,4 +1,4 @@
-//! TLS transport for the Embassy MQTT client (design 044).
+//! TLS transport for the Embassy MQTT client.
 //!
 //! `mqtts://` broker sessions: an `embedded-tls` 1.3 session over the Embassy
 //! TCP socket, wrapped in mountain-mqtt's [`ConnectionEmbedded`] so the MQTT
@@ -10,8 +10,8 @@
 //! The session loop ([`handle_messages`], [`State`], [`ChannelEventHandler`])
 //! is a port of mountain-mqtt-embassy's private equivalents (MIT OR
 //! Apache-2.0): upstream `run()` constructs a bare `TcpSocket` internally and
-//! offers no seam for a TLS session (design 044 D6). Keep the loop in sync
-//! with the fork when bumping it.
+//! offers no seam for a TLS session. Keep the loop in sync with the fork when
+//! bumping it.
 
 use alloc::string::String;
 use alloc::vec::Vec;
@@ -53,7 +53,7 @@ use crate::sntp::{self, SntpClock};
 /// covers RSA-4096 leaves with headroom.
 const CERT_BUFFER_SIZE: usize = 4096;
 
-/// TLS materials for a `mqtts://` broker connection (design 044 §4).
+/// TLS materials for a `mqtts://` broker connection.
 ///
 /// All references are `'static`: the session outlives `build()`, so buffers
 /// and the RNG live in `StaticCell`s (or equivalents) owned by the
@@ -155,10 +155,10 @@ impl embedded_io_async::Write for SharedTcp<'_, '_> {
 /// undecrypted bytes on the wire (`can_recv` on the shared socket). Checking
 /// both keeps coalesced packets flowing promptly.
 ///
-/// Known limitation (documented in design 044): wire bytes that decrypt to
-/// *no* application data (unsolicited session tickets, KeyUpdate) make
-/// `receive` wait for the next real record; if the broker stays silent, the
-/// keep-alive lapse tears the session down and the manager reconnects.
+/// Known limitation: wire bytes that decrypt to *no* application data
+/// (unsolicited session tickets, KeyUpdate) make `receive` wait for the next
+/// real record; if the broker stays silent, the keep-alive lapse tears the
+/// session down and the manager reconnects.
 struct TlsSession<'r, 'a, 'b> {
     tls: TlsConnection<'b, SharedTcp<'r, 'a>, Aes128GcmSha256>,
     socket: SharedTcp<'r, 'a>,
@@ -204,7 +204,7 @@ impl Connection for TlsSession<'_, '_, '_> {
 /// [`CryptoProvider`] pairing the injected TRNG with `rustpki` certificate
 /// verification (time from [`SntpClock`]). Client-certificate signing is
 /// deliberately absent — the mesh authenticates with MQTT credentials
-/// (design 044 non-goals).
+/// instead.
 struct TrngProvider<'a> {
     rng: &'a mut dyn CryptoRngCore,
     verifier: CertVerifier<'static, Aes128GcmSha256, SntpClock, CERT_BUFFER_SIZE>,
@@ -227,7 +227,7 @@ impl CryptoProvider for TrngProvider<'_> {
 /// The TLS broker manager: resolve → TCP → TLS handshake → MQTT session,
 /// reconnecting forever with the same [`Settings`] cadence as the plain
 /// path's `mqtt_manager::run` (`settings.address` is unused — the TLS path
-/// resolves `host` per attempt, design 044 D7).
+/// resolves `host` per attempt instead).
 #[allow(clippy::too_many_arguments)]
 pub(crate) async fn run_tls(
     stack: Stack<'static>,
@@ -255,7 +255,7 @@ pub(crate) async fn run_tls(
 
     loop {
         // Certificate validity needs real time — hold the first handshake
-        // until SNTP has synced (design 044 D5).
+        // until SNTP has synced.
         if sntp::unix_now().is_none() {
             #[cfg(feature = "defmt")]
             defmt::info!("MQTT-TLS: waiting for SNTP time sync...");

aimdb-mqtt-connector/src/lib.rs

@@ -9,7 +9,7 @@
 //! - `tokio-runtime`: Tokio-based connector using `rumqttc`
 //! - `embassy-runtime`: Embassy connector for embedded systems using `mountain-mqtt`
 //! - `embassy-tls`: TLS (`mqtts://`), broker authentication, DNS, and the
-//!   SNTP time source for the Embassy connector (design 044)
+//!   SNTP time source for the Embassy connector
 //! - `tracing`: Debug logging support (std)
 //! - `defmt`: Debug logging support (no_std)
 //!
@@ -110,7 +110,7 @@ pub mod embassy_client;
 #[cfg_attr(not(feature = "embassy-tls"), allow(dead_code))]
 pub(crate) mod sntp_codec;
 
-// TLS transport + SNTP time source for the Embassy client (design 044)
+// TLS transport + SNTP time source for the Embassy client
 #[cfg(feature = "embassy-tls")]
 pub mod embassy_tls;
 #[cfg(feature = "embassy-tls")]

aimdb-mqtt-connector/src/sntp.rs

@@ -1,11 +1,11 @@
-//! SNTP time source for TLS certificate validation (design 044 §6).
+//! SNTP time source for TLS certificate validation.
 //!
 //! The reference boards have no battery-backed RTC, but checking a
 //! certificate's validity window needs the current Unix time. This module
 //! keeps one crate-global clock: Unix seconds at the `embassy_time` epoch
 //! (boot), written after each SNTP sync and read through [`unix_now`] /
 //! [`SntpClock`]. The TLS manager spawns [`run`] alongside its broker loop
-//! and holds the first handshake until the first sync lands (design 044 D5).
+//! and holds the first handshake until the first sync lands.
 
 use core::sync::atomic::{AtomicU32, Ordering};