update docs

Author: yngrtc

src/description/mod.rs

@@ -36,7 +36,7 @@ use url::Url;
 pub(crate) const UNSPECIFIED_STR: &str = "Unspecified";
 pub(crate) const SDP_ATTRIBUTE_RID: &str = "rid";
 
-/// SessionDescription is used to expose local and remote session descriptions.
+/// RTCSessionDescription is used to expose local and remote session descriptions.
 #[derive(Default, Debug, Clone, Serialize, Deserialize)]
 pub struct RTCSessionDescription {
     #[serde(rename = "type")]

src/handler/data.rs

@@ -12,6 +12,8 @@ use shared::marshal::*;
 struct DataChannelInbound;
 #[derive(Default)]
 struct DataChannelOutbound;
+
+/// DataChannelHandler implements DataChannel Protocol handling
 #[derive(Default)]
 pub struct DataChannelHandler {
     data_channel_inbound: DataChannelInbound,

src/handler/demuxer.rs

@@ -43,6 +43,8 @@ fn match_srtp(b: &[u8]) -> bool {
 struct DemuxerInbound;
 #[derive(Default)]
 struct DemuxerOutbound;
+
+/// DemuxerHandler implements demuxing of STUN/DTLS/RTP/RTCP Protocol packets
 #[derive(Default)]
 pub struct DemuxerHandler {
     demuxer_inbound: DemuxerInbound,

src/handler/dtls.rs

@@ -26,6 +26,8 @@ struct DtlsOutbound {
     local_addr: SocketAddr,
     server_states: Rc<RefCell<ServerStates>>,
 }
+
+/// DtlsHandler implements DTLS Protocol handling
 pub struct DtlsHandler {
     dtls_inbound: DtlsInbound,
     dtls_outbound: DtlsOutbound,

src/handler/exception.rs

@@ -8,6 +8,7 @@ struct ExceptionInbound;
 #[derive(Default)]
 struct ExceptionOutbound;
 
+/// ExceptionHandler implements exception handling for inbound or outbound directions
 #[derive(Default)]
 pub struct ExceptionHandler {
     exception_inbound: ExceptionInbound,

src/handler/gateway.rs

@@ -33,6 +33,7 @@ struct GatewayOutbound {
     server_states: Rc<RefCell<ServerStates>>,
 }
 
+/// GatewayHandler implements Data/Media Selective Forward handling
 pub struct GatewayHandler {
     gateway_inbound: GatewayInbound,
     gateway_outbound: GatewayOutbound,

src/handler/interceptor.rs

@@ -15,6 +15,8 @@ struct InterceptorInbound {
 struct InterceptorOutbound {
     server_states: Rc<RefCell<ServerStates>>,
 }
+
+/// InterceptorHandler implements RTCP feedback handling
 pub struct InterceptorHandler {
     interceptor_inbound: InterceptorInbound,
     interceptor_outbound: InterceptorOutbound,

src/handler/sctp.rs

@@ -29,6 +29,8 @@ struct SctpOutbound {
     local_addr: SocketAddr,
     server_states: Rc<RefCell<ServerStates>>,
 }
+
+/// SctpHandler implements SCTP Protocol handling
 pub struct SctpHandler {
     sctp_inbound: SctpInbound,
     sctp_outbound: SctpOutbound,

src/handler/srtp.rs

@@ -17,6 +17,8 @@ struct SrtpInbound {
 struct SrtpOutbound {
     server_states: Rc<RefCell<ServerStates>>, // for local_srtp_context
 }
+
+/// SrtpHandler implements SRTP/RTP/RTCP Protocols handling
 pub struct SrtpHandler {
     srtp_inbound: SrtpInbound,
     srtp_outbound: SrtpOutbound,

src/handler/stun.rs

@@ -9,6 +9,8 @@ use stun::message::Message;
 struct StunInbound;
 #[derive(Default)]
 struct StunOutbound;
+
+/// StunHandler implements STUN Protocol handling
 #[derive(Default)]
 pub struct StunHandler {
     stun_inbound: StunInbound,