[F42] cargo doc --workspace --no-deps clean (0 warnings)

Fix all 33 rustdoc warnings across the workspace:

- Unresolved intra-doc links: rewrite [`name`] → either backtick text
  (when not actually a link) or fully-qualified `[Type::method]` /
  `[crate::module::name]` form. Affected: mxaccess-codec
  (asb_variant, item_control, metadata_query, observed_write_template,
  reference_handle, write_message), mxaccess-rpc (pdu), mxaccess-nmx
  (client), mxaccess-asb-nettcp (nmf), mxaccess-callback (exporter),
  mxaccess (asb_session, session, lib).
- Bracket-text being interpreted as link refs (e.g. `body[17]` →
  `` `body[17]` ``).
- Private-item references in public docs (CALLBACK_BROADCAST_CAPACITY,
  recover_connection_core, mxvalue_to_writevalue) reduced to
  backtick-text since they aren't part of the public API.

`RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps` now
exits clean. Workspace 759 tests pass; clippy clean.

Defers `#![warn(missing_docs)]` lint to a future pass — the cleanup
target is the broken-link warnings, which are signal; missing-docs
would surface hundreds of low-priority public-item gaps that are out
of scope for this F-number.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Joseph Doherty
2026-05-06 04:39:51 -04:00
parent 34045c2f6d
commit e79e289743
13 changed files with 36 additions and 35 deletions
+8 -7
View File
@@ -21,14 +21,15 @@
//! Implements:
//! * [`AsbSession::connect`] — TCP connect → preamble → DH handshake
//! → ready session.
//! * [`AsbSession::register_items`] / [`unregister_items`] /
//! [`read`] / [`write`] — per-operation thin async wrappers.
//! * [`AsbSession::keep_alive`] / [`disconnect`] / [`shutdown`] —
//! lifecycle.
//! * [`AsbSession::register_items`] / [`AsbSession::unregister_items`] /
//! [`AsbSession::read`] / [`AsbSession::write`] — per-operation thin
//! async wrappers.
//! * [`AsbSession::keep_alive`] / [`AsbSession::disconnect`] /
//! `AsbSession::shutdown` — lifecycle.
//! * [`AsbSession::create_subscription`] /
//! [`add_monitored_items`] / [`publish`] /
//! [`delete_monitored_items`] / [`delete_subscription`] —
//! subscription primitives.
//! [`AsbSession::add_monitored_items`] / [`AsbSession::publish`] /
//! [`AsbSession::delete_monitored_items`] /
//! [`AsbSession::delete_subscription`] — subscription primitives.
//! * [`AsbSession::subscribe`] — returns an [`AsbSubscription`]
//! `Stream<Item = Result<MonitoredItemValue, Error>>` driven by a
//! background publish-loop. Drop of the stream aborts the loop.
+2 -2
View File
@@ -397,8 +397,8 @@ impl Session {
}
/// Write a value to a tag (`MxValue` overload). Delegates to
/// [`Self::write_value`] after converting `value` via
/// [`mxvalue_to_writevalue`].
/// [`Self::write_value`] after converting `value` via the private
/// `mxvalue_to_writevalue` helper.
///
/// # Errors
/// As for [`Self::write_value`], plus
+4 -4
View File
@@ -119,7 +119,7 @@ const CALLBACK_BROADCAST_CAPACITY: usize = 256;
/// ## Lag behavior
///
/// The underlying broadcast channel has a fixed capacity
/// ([`CALLBACK_BROADCAST_CAPACITY`]). Slow consumers that fall behind
/// (`CALLBACK_BROADCAST_CAPACITY`). Slow consumers that fall behind
/// receive `Some(Err(Error::Configuration(InvalidArgument)))` whose
/// detail string contains the lag-loss count. The stream stays open
/// and resumes from the next available message — same shape as
@@ -449,7 +449,7 @@ impl Session {
/// `(host, port, service_ipid)` before `RegisterEngine2`. This
/// constructor takes the resolved triple by hand — useful for
/// tests, deterministic probes, and non-Windows builds. Use
/// [`Self::connect_nmx_auto`] (Windows + `windows-com` feature) to
/// `Self::connect_nmx_auto` (Windows + `windows-com` feature) to
/// drive the auto-resolving path.
///
/// On success: a `RegisterEngine2` round-trip has completed and the
@@ -650,7 +650,7 @@ impl Session {
/// `RecoverConnectionCore` (`cs:442-474`).
///
/// Per attempt: emit [`RecoveryEvent::Started`], invoke
/// [`recover_connection_core`](Self::recover_connection_core) (rebuild
/// the private `recover_connection_core` helper (rebuild
/// the NMX transport via the installed [`RebuildFactory`], re-run
/// `RegisterEngine2` with the saved callback OBJREF, replay every
/// active subscription's `AdviseSupervisory`, atomically swap the
@@ -821,7 +821,7 @@ impl Session {
/// This accessor is the test seam + escape hatch consumers can use
/// today to observe the raw stream.
///
/// Receivers can lag by up to [`CALLBACK_BROADCAST_CAPACITY`]
/// Receivers can lag by up to `CALLBACK_BROADCAST_CAPACITY`
/// messages before the broadcast channel starts dropping; lagged
/// receivers see [`tokio::sync::broadcast::error::RecvError::Lagged`].
#[must_use]