Skip to content

Commit e9329e2

Browse files
authored
Add spec links to public items (#591)
* dtls: Add spec links to public items * ice: Add spec links to public items * rtcp: Add spec links to public items * rtp: Add spec links to public items * sctp: Add spec links to public items * sdp: Add spec links to public items * webrtc: Add spec links to public items
1 parent 19004ef commit e9329e2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+420
-57
lines changed

dtls/src/alert/mod.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,11 @@ impl From<u8> for AlertDescription {
144144
// preventing the failed session from being used to establish new
145145
// connections. Like other messages, alert messages are encrypted and
146146
// compressed, as specified by the current connection state.
147-
// https://tools.ietf.org/html/rfc5246#section-7.2
147+
/// ## Specifications
148+
///
149+
/// * [RFC 5246 §7.2]
150+
///
151+
/// [RFC 5246 §7.2]: https://tools.ietf.org/html/rfc5246#section-7.2
148152
#[derive(Copy, Clone, PartialEq, Debug)]
149153
pub struct Alert {
150154
pub(crate) alert_level: AlertLevel,

dtls/src/application_data.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ use crate::error::Result;
77
// fragmented, compressed, and encrypted based on the current connection
88
// state. The messages are treated as transparent data to the record
99
// layer.
10-
// https://tools.ietf.org/html/rfc5246#section-10
10+
/// ## Specifications
11+
///
12+
/// * [RFC 5246 §10]
13+
///
14+
/// [RFC 5246 §10]: https://tools.ietf.org/html/rfc5246#section-10
1115
#[derive(Clone, PartialEq, Eq, Debug)]
1216
pub struct ApplicationData {
1317
pub data: Vec<u8>,

dtls/src/change_cipher_spec/mod.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,11 @@ use super::error::*;
1212
// ciphering strategies. The protocol consists of a single message,
1313
// which is encrypted and compressed under the current (not the pending)
1414
// connection state. The message consists of a single byte of value 1.
15-
// https://tools.ietf.org/html/rfc5246#section-7.1
15+
/// ## Specifications
16+
///
17+
/// * [RFC 5246 §7.1]
18+
///
19+
/// [RFC 5246 §7.1]: https://tools.ietf.org/html/rfc5246#section-7.1
1620
#[derive(Clone, PartialEq, Eq, Debug)]
1721
pub struct ChangeCipherSpec;
1822

dtls/src/content.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ use super::change_cipher_spec::*;
66
use super::handshake::*;
77
use crate::error::*;
88

9-
// https://tools.ietf.org/html/rfc4346#section-6.2.1
9+
/// ## Specifications
10+
///
11+
/// * [RFC 4346 §6.2.1]
12+
///
13+
/// [RFC 4346 §6.2.1]: https://tools.ietf.org/html/rfc4346#section-6.2.1
1014
#[derive(Default, Copy, Clone, PartialEq, Eq, Debug)]
1115
pub enum ContentType {
1216
ChangeCipherSpec = 20,

dtls/src/extension/extension_supported_elliptic_curves.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ use crate::curve::named_curve::*;
66

77
const EXTENSION_SUPPORTED_GROUPS_HEADER_SIZE: usize = 6;
88

9-
// https://tools.ietf.org/html/rfc8422#section-5.1.1
9+
/// ## Specifications
10+
///
11+
/// * [RFC 8422 §5.1.1]
12+
///
13+
/// [RFC 8422 §5.1.1]: https://tools.ietf.org/html/rfc8422#section-5.1.1
1014
#[derive(Clone, Debug, PartialEq, Eq)]
1115
pub struct ExtensionSupportedEllipticCurves {
1216
pub elliptic_curves: Vec<NamedCurve>,

dtls/src/extension/extension_supported_point_formats.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ pub type EllipticCurvePointFormat = u8;
99

1010
pub const ELLIPTIC_CURVE_POINT_FORMAT_UNCOMPRESSED: EllipticCurvePointFormat = 0;
1111

12-
// https://tools.ietf.org/html/rfc4492#section-5.1.2
12+
/// ## Specifications
13+
///
14+
/// * [RFC 4492 §5.1.2]
15+
///
16+
/// [RFC 4492 §5.1.2]: https://tools.ietf.org/html/rfc4492#section-5.1.2
1317
#[derive(Clone, Debug, PartialEq, Eq)]
1418
pub struct ExtensionSupportedPointFormats {
1519
pub(crate) point_formats: Vec<EllipticCurvePointFormat>,

dtls/src/extension/extension_supported_signature_algorithms.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ use crate::signature_hash_algorithm::*;
66

77
const EXTENSION_SUPPORTED_SIGNATURE_ALGORITHMS_HEADER_SIZE: usize = 6;
88

9-
// https://tools.ietf.org/html/rfc5246#section-7.4.1.4.1
9+
/// ## Specifications
10+
///
11+
/// * [RFC 5246 §7.4.1.4.1]
12+
///
13+
/// [RFC 5246 §7.4.1.4.1]: https://tools.ietf.org/html/rfc5246#section-7.4.1.4.1
1014
#[derive(Clone, Debug, PartialEq, Eq)]
1115
pub struct ExtensionSupportedSignatureAlgorithms {
1216
pub(crate) signature_hash_algorithms: Vec<SignatureHashAlgorithm>,

dtls/src/extension/extension_use_extended_master_secret.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ use super::*;
55

66
const EXTENSION_USE_EXTENDED_MASTER_SECRET_HEADER_SIZE: usize = 4;
77

8-
// https://tools.ietf.org/html/rfc8422
8+
/// ## Specifications
9+
///
10+
/// * [RFC 8422]
11+
///
12+
/// [RFC 8422]: https://tools.ietf.org/html/rfc8422
913
#[derive(Clone, Debug, PartialEq, Eq)]
1014
pub struct ExtensionUseExtendedMasterSecret {
1115
pub(crate) supported: bool,

dtls/src/extension/extension_use_srtp.rs

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@ mod extension_use_srtp_test;
44
use super::*;
55

66
// SRTPProtectionProfile defines the parameters and options that are in effect for the SRTP processing
7-
// https://tools.ietf.org/html/rfc5764#section-4.1.2
7+
/// ## Specifications
8+
///
9+
/// * [RFC 5764 §4.1.2]
10+
///
11+
/// [RFC 5764 §4.1.2]: https://tools.ietf.org/html/rfc5764#section-4.1.2
812
#[allow(non_camel_case_types)]
913
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
1014
pub enum SrtpProtectionProfile {
@@ -29,7 +33,11 @@ impl From<u16> for SrtpProtectionProfile {
2933

3034
const EXTENSION_USE_SRTPHEADER_SIZE: usize = 6;
3135

32-
// https://tools.ietf.org/html/rfc8422
36+
/// ## Specifications
37+
///
38+
/// * [RFC 8422]
39+
///
40+
/// [RFC 8422]: https://tools.ietf.org/html/rfc8422
3341
#[allow(non_camel_case_types)]
3442
#[derive(Clone, Debug, PartialEq, Eq)]
3543
pub struct ExtensionUseSrtp {

dtls/src/extension/renegotiation_info.rs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ const RENEGOTIATION_INFO_HEADER_SIZE: usize = 5;
88

99
/// RenegotiationInfo allows a Client/Server to
1010
/// communicate their renegotiation support
11-
/// https://tools.ietf.org/html/rfc5746
11+
///
12+
/// ## Specifications
13+
///
14+
/// * [RFC 5746]
15+
///
16+
/// [RFC 5746]: https://tools.ietf.org/html/rfc5746
1217
#[derive(Clone, Debug, PartialEq, Eq)]
1318
pub struct ExtensionRenegotiationInfo {
1419
pub(crate) renegotiated_connection: u8,

0 commit comments

Comments
 (0)