docs

Author: kenaniah

webrtc/src/.DS_Store

@@ -1,22 +1,28 @@
 use std::fmt;
 
-/// ICEGatheringState describes the state of the candidate gathering process.
+/// Describes the state of the ICE candidate gathering process.
 #[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
 pub enum RTCIceGatheringState {
     #[default]
     Unspecified,
 
-    /// ICEGatheringStateNew indicates that any of the ICETransports are
+    /// 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.
+    ///
+    /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
     New,
 
-    /// ICEGatheringStateGathering indicates that any of the ICETransports
+    /// Any of the [`RTCIceTransport`]s
     /// are in the "gathering" state.
+    ///
+    /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
     Gathering,
 
-    /// ICEGatheringStateComplete indicates that at least one ICETransport
-    /// exists, and all ICETransports are in the "completed" gathering state.
+    /// At least one [`RTCIceTransport`]
+    /// exists, and all [`RTCIceTransport`]s are in the "complete" gathering state.
+    ///
+    /// [`RTCIceTransport`]: crate::ice_transport::RTCIceTransport
     Complete,
 }
 

webrtc/src/ice_transport/ice_gathering_state.rs

@@ -1,22 +1,24 @@
-/// AnswerOptions structure describes the options used to control the answer
-/// creation process.
+/// Describes the options used to control the answer creation process.
 #[derive(Default, Debug, PartialEq, Eq, Copy, Clone)]
 pub struct RTCAnswerOptions {
-    /// voice_activity_detection allows the application to provide information
+    /// Allows the application to provide information
     /// about whether it wishes voice detection feature to be enabled or disabled.
     pub voice_activity_detection: bool,
 }
 
-/// OfferOptions structure describes the options used to control the offer
-/// creation process
+/// Describes the options used to control the offer creation process
 #[derive(Default, Debug, PartialEq, Eq, Copy, Clone)]
 pub struct RTCOfferOptions {
-    /// voice_activity_detection allows the application to provide information
+    /// Allows the application to provide information
     /// about whether it wishes voice detection feature to be enabled or disabled.
     pub voice_activity_detection: bool,
 
-    /// ice_restart forces the underlying ice gathering process to be restarted.
-    /// When this value is true, the generated description will have ICE
-    /// credentials that are different from the current credentials
+    /// When this value is `true`, the generated description will have ICE
+    /// credentials that are different from the current credentials. This
+    /// will result in the ICE connection being restarted when the offer is
+    /// applied.
+    ///
+    /// When this value is `false`, the generated description will have the
+    /// same ICE credentials as the current offer. This is the default.
     pub ice_restart: bool,
 }

webrtc/src/peer_connection/offer_answer_options.rs

@@ -2,11 +2,12 @@ use std::fmt;
 
 use serde::{Deserialize, Serialize};
 
-/// The bundle policy affects which media tracks are negotiated if the remote
-/// endpoint is not bundle-aware, and what ICE candidates are gathered. If the
+/// The bundle policy
+/// ([RFC8829](https://tools.ietf.org/html/rfc8829#section-4.1.1)) affects
+/// which media tracks are negotiated if the remote endpoint is not
+/// bundle-aware, and what ICE candidates are gathered. If the
 /// remote endpoint is bundle-aware, all media tracks and data channels are
-/// bundled onto the same transport. This is described in
-/// [RFC8829](https://tools.ietf.org/html/rfc8829).
+/// bundled onto the same transport.
 #[derive(Default, Debug, PartialEq, Eq, Copy, Clone, Serialize, Deserialize)]
 pub enum RTCBundlePolicy {
     #[default]

webrtc/src/peer_connection/policy/bundle_policy.rs

@@ -3,9 +3,9 @@ use std::fmt;
 use serde::{Deserialize, Serialize};
 
 /// Defines the ICE candidate policy
-/// ([RFC8829](https://datatracker.ietf.org/doc/html/rfc8829#section-4.1.1))
-/// that will be used to determine the permitted ICE candidates. Permitted
-/// candidates will be used for connectivity checks.
+/// ([RFC8829](https://tools.ietf.org/html/rfc8829#section-4.1.1))
+/// that will be used to determine the permitted ICE candidates. Only the
+/// permitted candidates will be used for connectivity checks.
 #[derive(Default, Debug, PartialEq, Eq, Copy, Clone, Serialize, Deserialize)]
 pub enum RTCIceTransportPolicy {
     #[default]

webrtc/src/peer_connection/policy/ice_transport_policy.rs

@@ -2,8 +2,8 @@ use std::fmt;
 
 use serde::{Deserialize, Serialize};
 
-/// RTCPMuxPolicy affects what ICE candidates are gathered to support
-/// non-multiplexed RTCP.
+/// The mux policy [RFC8829](https://tools.ietf.org/html/rfc8829#section-4.1.1)
+/// affects what ICE candidates are gathered to support non-multiplexed RTCP.
 #[derive(Default, Debug, PartialEq, Eq, Copy, Clone, Serialize, Deserialize)]
 pub enum RTCRtcpMuxPolicy {
     #[default]

webrtc/src/peer_connection/policy/rtcp_mux_policy.rs

@@ -20,36 +20,38 @@ impl fmt::Display for StateChangeOp {
     }
 }
 
-/// SignalingState indicates the signaling state of the offer/answer process.
+/// Indicates the signaling state of the offer/answer process.
 #[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
 pub enum RTCSignalingState {
     #[default]
     Unspecified = 0,
 
-    /// SignalingStateStable indicates there is no offer/answer exchange in
+    /// There is no offer/answer exchange in
     /// progress. This is also the initial state, in which case the local and
-    /// remote descriptions are nil.
+    /// remote descriptions aren't set.
     Stable,
 
-    /// SignalingStateHaveLocalOffer indicates that a local description, of
+    /// A local description, of
     /// type "offer", has been successfully applied.
     HaveLocalOffer,
 
-    /// SignalingStateHaveRemoteOffer indicates that a remote description, of
+    /// A remote description, of
     /// type "offer", has been successfully applied.
     HaveRemoteOffer,
 
-    /// SignalingStateHaveLocalPranswer indicates that a remote description
+    /// A remote description
     /// of type "offer" has been successfully applied and a local description
     /// of type "pranswer" has been successfully applied.
     HaveLocalPranswer,
 
-    /// SignalingStateHaveRemotePranswer indicates that a local description
+    /// A local description
     /// of type "offer" has been successfully applied and a remote description
     /// of type "pranswer" has been successfully applied.
     HaveRemotePranswer,
 
-    /// SignalingStateClosed indicates The PeerConnection has been closed.
+    /// The [`RTCPeerConnection`] has been closed.
+    ///
+    /// [`RTCPeerConnection`]: crate::peer_connection::RTCPeerConnection
     Closed,
 }