Skip to content

Commit ee79c6b

Browse files
committed
docs
1 parent 29ed12c commit ee79c6b

File tree

1 file changed

+4
-3
lines changed
  • webrtc/src/peer_connection

1 file changed

+4
-3
lines changed

webrtc/src/peer_connection/mod.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -179,9 +179,10 @@ struct NegotiationNeededParams {
179179
check_negotiation_needed_params: CheckNegotiationNeededParams,
180180
}
181181

182-
/// PeerConnection represents a WebRTC connection that establishes a
183-
/// peer-to-peer communications with another PeerConnection instance in a
184-
/// browser, or to another endpoint implementing the required protocols.
182+
/// Represents an individual connection between a local device and a remote peer.
183+
///
184+
/// A high-level overview of how peer connections work is available in the [crate-level
185+
/// documentation](crate).
185186
pub struct RTCPeerConnection {
186187
stats_id: String,
187188
idp_login_url: Option<String>,

0 commit comments

Comments
 (0)