docs

Author: kenaniah

webrtc/src/ice_transport/ice_gathering_state.rs

@@ -7,20 +7,20 @@ pub enum RTCIceGatheringState {
     Unspecified,
 
     /// Any of the [`RTCIceTransport`]s are
-    /// in the "new" gathering state and none of the transports are in the
-    /// "gathering" state, or there are no transports.
+    /// in the `new` gathering state and none of the transports are in the
+    /// `gathering` state, or there are no transports.
     ///
     /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
     New,
 
     /// Any of the [`RTCIceTransport`]s
-    /// are in the "gathering" state.
+    /// are in the `gathering` state.
     ///
     /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
     Gathering,
 
     /// At least one [`RTCIceTransport`]
-    /// exists, and all [`RTCIceTransport`]s are in the "complete" gathering state.
+    /// exists, and all [`RTCIceTransport`]s are in the `complete` gathering state.
     ///
     /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
     Complete,

webrtc/src/peer_connection/peer_connection_state.rs

@@ -8,34 +8,56 @@ pub enum RTCPeerConnectionState {
     #[default]
     Unspecified,
 
-    /// PeerConnectionStateNew indicates that any of the ICETransports or
-    /// DTLSTransports are in the "new" state and none of the transports are
-    /// in the "connecting", "checking", "failed" or "disconnected" state, or
-    /// all transports are in the "closed" state, or there are no transports.
-    New,
-
-    /// PeerConnectionStateConnecting indicates that any of the
-    /// ICETransports or DTLSTransports are in the "connecting" or
-    /// "checking" state and none of them is in the "failed" state.
-    Connecting,
+    /// Indicates that the [`RTCPeerConnection`] is closed
+    ///
+    /// [`RTCPeerConnection`]: crate::peer_connection::RTCPeerConnection
+    Closed,
 
-    /// PeerConnectionStateConnected indicates that all ICETransports and
-    /// DTLSTransports are in the "connected", "completed" or "closed" state
-    /// and at least one of them is in the "connected" or "completed" state.
-    Connected,
+    /// Indicates all of the following:
+    /// - the previous state does not apply
+    /// - any of the [`RTCIceTransport`]s or [`RTCDtlsTransport`]s
+    /// are in a `failed` state
+    ///
+    /// [`RTCDtlsTransport`]: crate::dtls_transport::RTCDtlsTransport
+    /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
+    Failed,
 
-    /// PeerConnectionStateDisconnected indicates that any of the
-    /// ICETransports or DTLSTransports are in the "disconnected" state
-    /// and none of them are in the "failed" or "connecting" or "checking" state.
+    /// Indicates all of the following:
+    /// - none of the previous states apply
+    /// - any of the [`RTCIceTransport`]s are in the `disconnected` state
+    ///
+    /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
     Disconnected,
 
-    /// PeerConnectionStateFailed indicates that any of the ICETransports
-    /// or DTLSTransports are in a "failed" state.
-    Failed,
+    /// Indicates all of the following:
+    /// - none of the previous states apply
+    /// - all of the [`RTCIceTransport`]s are in the `new` or `closed` state
+    /// - all of the [`RTCDtlsTransport`]s (if any) are in the `new` or
+    /// `closed` state
+    ///
+    /// [`RTCDtlsTransport`]: crate::dtls_transport::RTCDtlsTransport
+    /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
+    New,
 
-    /// PeerConnectionStateClosed indicates the peer connection is closed
-    /// and the isClosed member variable of PeerConnection is true.
-    Closed,
+    /// Indicates all of the following:
+    /// - none of the previous states apply
+    /// - any of the [`RTCIceTransport`]s are in the `new` or `checking` state, or
+    /// - any of the [`RTCDtlsTransport`]s are in the `new` or `connecting` state
+    ///
+    /// [`RTCDtlsTransport`]: crate::dtls_transport::RTCDtlsTransport
+    /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
+    Connecting,
+
+    /// Indicates all of the following:
+    /// - none of the previous states apply
+    /// - all of the [`RTCIceTransport`]s are in the `connected`, `completed`, or
+    /// `closed` state
+    /// - all of the [`RTCDtlsTransport`]s (if any) are in the `connected` or
+    /// `closed` state
+    ///
+    /// [`RTCDtlsTransport`]: crate::dtls_transport::RTCDtlsTransport
+    /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
+    Connected,
 }
 
 const PEER_CONNECTION_STATE_NEW_STR: &str = "new";

webrtc/src/peer_connection/signaling_state.rs

@@ -32,21 +32,21 @@ pub enum RTCSignalingState {
     Stable,
 
     /// A local description, of
-    /// type "offer", has been successfully applied.
+    /// type `offer`, has been successfully applied.
     HaveLocalOffer,
 
     /// A remote description, of
-    /// type "offer", has been successfully applied.
+    /// type `offer`, has been successfully applied.
     HaveRemoteOffer,
 
     /// A remote description
-    /// of type "offer" has been successfully applied and a local description
-    /// of type "pranswer" has been successfully applied.
+    /// of type `offer` has been successfully applied and a local description
+    /// of type `pranswer` has been successfully applied.
     HaveLocalPranswer,
 
     /// A local description
-    /// of type "offer" has been successfully applied and a remote description
-    /// of type "pranswer" has been successfully applied.
+    /// of type `offer` has been successfully applied and a remote description
+    /// of type `pranswer` has been successfully applied.
     HaveRemotePranswer,
 
     /// The [`RTCPeerConnection`] has been closed.