docs

Author: kenaniah

webrtc/src/lib.rs

@@ -20,9 +20,6 @@
 //! - Support for Multicast DNS (mDNS)
 //! - Interceptors for RTP, RTCP, and DataChannel packets
 //!
-//! ## Usage
-//! ...
-//!
 //! ## Key Concepts
 //!
 //! The WebRTC API, as defined by the W3C specification, is composed of a number of
@@ -74,8 +71,8 @@
 //! - [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)
 //! - [MIT License](https://opensource.org/license/mit/)
 //!
-//! [`RTCConfiguration`]: peer_connection::configuration::RTCConfiguration
-//! [`RTCPeerConnection`]: peer_connection::RTCPeerConnection
+//! [`RTCConfiguration`]: crate::peer_connection::configuration::RTCConfiguration
+//! [`RTCPeerConnection`]: crate::peer_connection::RTCPeerConnection
 
 // re-export sub-crates
 pub use {data, dtls, ice, interceptor, mdns, media, rtcp, rtp, sctp, sdp, srtp, stun, turn, util};

webrtc/src/peer_connection/peer_connection_state.rs

@@ -1,6 +1,8 @@
 use std::fmt;
 
-/// PeerConnectionState indicates the state of the PeerConnection.
+/// Indicates the state of the [`RTCPeerConnection`].
+///
+/// [`RTCPeerConnection`]: crate::peer_connection::RTCPeerConnection
 #[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
 pub enum RTCPeerConnectionState {
     #[default]

webrtc/src/peer_connection/policy/rtcp_mux_policy.rs

@@ -9,14 +9,14 @@ pub enum RTCRtcpMuxPolicy {
     #[default]
     Unspecified = 0,
 
-    /// RTCPMuxPolicyNegotiate indicates to gather ICE candidates for both
+    /// Gather ICE candidates for both
     /// RTP and RTCP candidates. If the remote-endpoint is capable of
     /// multiplexing RTCP, multiplex RTCP on the RTP candidates. If it is not,
     /// use both the RTP and RTCP candidates separately.
     #[serde(rename = "negotiate")]
     Negotiate = 1,
 
-    /// RTCPMuxPolicyRequire indicates to gather ICE candidates only for
+    /// Gather ICE candidates only for
     /// RTP and multiplex RTCP on the RTP candidates. If the remote endpoint is
     /// not capable of rtcp-mux, session negotiation will fail.
     #[serde(rename = "require")]