Add documentation to Rust public APIs (#834)

Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>

Author: kixelated

justfile

@@ -292,6 +292,9 @@ check:
 	cargo clippy --all-targets --all-features -- -D warnings
 	cargo fmt --all --check
 
+	# Check documentation warnings (only workspace crates, not dependencies)
+	RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --workspace
+
 	# requires: cargo install cargo-shear
 	cargo shear
 

rs/hang-cli/Cargo.toml

@@ -14,6 +14,7 @@ categories = ["multimedia", "network-programming", "web-programming"]
 [[bin]]
 name = "hang"
 path = "src/main.rs"
+doc = false
 
 [features]
 default = ["iroh"]

rs/hang-cli/src/main.rs

@@ -20,7 +20,7 @@ pub struct Cli {
 	/// Iroh configuration
 	#[command(flatten)]
 	#[cfg(feature = "iroh")]
-	iroh: moq_native::iroh::EndpointConfig,
+	iroh: moq_native::IrohEndpointConfig,
 
 	#[command(subcommand)]
 	command: Command,

rs/hang-cli/src/web.rs

@@ -12,7 +12,7 @@ use tower_http::services::ServeDir;
 // Initialize the HTTP server (but don't serve yet).
 pub async fn run_web(
 	bind: SocketAddr,
-	tls_info: Arc<RwLock<moq_native::TlsInfo>>,
+	tls_info: Arc<RwLock<moq_native::ServerTlsInfo>>,
 	public: Option<PathBuf>,
 ) -> anyhow::Result<()> {
 	let listen = tokio::net::lookup_host(bind)

rs/hang/src/catalog/mod.rs

@@ -1,22 +1,19 @@
 //! The catalog describes available media tracks and codecs.
 //!
-//! This module provides JSON-based catalog functionality that allows broadcasters
-//! to describe their available audio and video tracks, including codec information,
-//! resolution, bitrates, and other metadata. Consumers can subscribe to catalog
-//! tracks to discover and choose appropriate tracks for their capabilities.
+//! This is a JSON blob that can be live updated like any other track in MoQ.
+//! It describes the available audio and video tracks, including codec information,
+//! resolution, bitrates, and other metadata.
 
 mod audio;
 mod chat;
 mod preview;
 mod root;
-mod track;
 mod user;
 mod video;
 
 pub use audio::*;
 pub use chat::*;
 pub use preview::*;
 pub use root::*;
-pub use track::*;
 pub use user::*;
 pub use video::*;

rs/hang/src/catalog/root.rs

@@ -5,7 +5,7 @@ use std::sync::{Arc, Mutex, MutexGuard};
 /// The catalog format is a JSON file that describes the tracks available in a broadcast.
 use serde::{Deserialize, Serialize};
 
-use crate::catalog::{Audio, AudioConfig, Chat, Track, User, Video, VideoConfig};
+use crate::catalog::{Audio, AudioConfig, Chat, User, Video, VideoConfig};
 use crate::Result;
 use moq_lite::Produce;
 
@@ -39,7 +39,7 @@ pub struct Catalog {
 
 	/// Preview information about the broadcast
 	#[serde(default)]
-	pub preview: Option<Track>,
+	pub preview: Option<moq_lite::Track>,
 }
 
 impl Catalog {
@@ -138,7 +138,7 @@ impl Catalog {
 /// Produces a catalog track that describes the available media tracks.
 ///
 /// The JSON catalog is updated when tracks are added/removed but is *not* automatically published.
-/// You'll have to call [`publish`](Self::publish) once all updates are complete.
+/// You'll have to call [`lock`](Self::lock) to update and publish the catalog.
 #[derive(Clone)]
 pub struct CatalogProducer {
 	/// Access to the underlying track producer.
@@ -163,7 +163,7 @@ impl CatalogProducer {
 		}
 	}
 
-	/// Create a consumer for this catalog, receiving updates as they're [published](Self::publish).
+	/// Create a consumer for this catalog, receiving updates as they're published.
 	pub fn consume(&self) -> CatalogConsumer {
 		CatalogConsumer::new(self.track.consume())
 	}
@@ -180,6 +180,9 @@ impl From<moq_lite::TrackProducer> for CatalogProducer {
 	}
 }
 
+/// RAII guard for modifying a catalog with automatic publishing on drop.
+///
+/// Obtained via [`CatalogProducer::lock`].
 pub struct CatalogGuard<'a> {
 	catalog: MutexGuard<'a, Catalog>,
 	track: &'a mut moq_lite::TrackProducer,

rs/hang/src/catalog/track.rs

@@ -69,7 +69,7 @@ pub struct Display {
 #[serde(rename_all = "camelCase")]
 pub struct VideoConfig {
 	/// The codec, see the registry for details:
-	/// https://w3c.github.io/webcodecs/codec_registry.html
+	/// <https://w3c.github.io/webcodecs/codec_registry.html>
 	#[serde_as(as = "DisplayFromStr")]
 	pub codec: VideoCodec,