Documentation improvements

Signed-off-by: Matt Johnston <[email protected]>

Author: mkj

mctp-estack/src/lib.rs

@@ -3,21 +3,23 @@
  * Copyright (c) 2024-2025 Code Construct
  */
 
-//! MCTP Stack
+//! # MCTP Stack
 //!
 //! This crate provides a MCTP stack that can be embedded in other programs
-//! or devices. A [`Stack`] handles MCTP message formatting and parsing, independent
-//! of any particular MCTP transport binding.
+//! or devices.
 //!
 //! A [`Router`] object lets programs use a [`Stack`] with
-//! MCTP transport binding links. Each "port" handles transmitting and receiving
+//! MCTP transport binding links. Each *Port* handles transmitting and receiving
 //! packets independently. Messages destined for the stack's own EID will
 //! be passed to applications.
 //!
 //! Applications can create [`router::RouterAsyncListener`] and [`router::RouterAsyncReqChannel`]
 //! instances to communicate over MCTP. Those implement the standard [`mctp` crate](mctp)
 //! async traits.
 //!
+//! The IO-less [`Stack`] handles MCTP message formatting and parsing, independent
+//! of any particular MCTP transport binding.
+//!
 //! ## Configuration
 //!
 //! `mctp-estack` uses fixed sizes to be suitable on no-alloc platforms.
@@ -30,6 +32,8 @@
 
 /// Re-exported so that callers can use the same `heapless` version.
 ///
+/// `heapless::Vec` is currently an argument of `send_fill()` in transports.
+///
 /// TODO: will be replaced with something else, maybe `heapless::VecView` once
 /// released.
 pub use heapless::Vec;
@@ -141,6 +145,9 @@ type Header = libmctp::base_packet::MCTPTransportHeader<[u8; HEADER_LEN]>;
 #[derive(Debug)]
 pub struct ReceiveHandle(usize);
 
+/// Low level MCTP stack.
+///
+/// This is an IO-less MCTP stack, independent of any particular transport.
 #[derive(Debug)]
 pub struct Stack {
     own_eid: Eid,

mctp/src/lib.rs

@@ -10,7 +10,7 @@
 #![forbid(unsafe_code)]
 #![warn(missing_docs)]
 
-//! Management Component Transport Protocol (MCTP)
+//! # Management Component Transport Protocol (MCTP)
 //!
 //! This crate provides common types and traits for MCTP.
 //! Transport implementations can implement [`ReqChannel`] and [`Listener`] to