Skip to content

Commit e8716fb

Browse files
committed
chore: resolve rustdoc warnings
1 parent ebedbfa commit e8716fb

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

media/sdp-types/src/media_description.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use crate::{
88
use bytesstr::BytesStr;
99
use std::fmt::{self, Debug};
1010

11-
/// Part of the [`SessionDescription`] describes a single media session
11+
/// Part of the [`SessionDescription`](crate::SessionDescription) describes a single media session
1212
///
1313
/// [RFC8866](https://www.rfc-editor.org/rfc/rfc8866.html#section-5.14)
1414
#[derive(Debug, Clone)]

sip/sip-types/src/header/headers.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,13 +57,13 @@ impl Headers {
5757
self.entries.iter().any(|entry| &entry.name == name)
5858
}
5959

60-
/// Inserts `header` using its [`HeaderNamed`] and [`InsertIntoHeaders`] implementation to the front of the list
60+
/// Inserts `header` using its [`DynNamed`] and [`ExtendValues`] implementation to the front of the list
6161
#[inline]
6262
pub fn insert_named_front<H: DynNamed + ExtendValues + ?Sized>(&mut self, header: &H) {
6363
self.insert_type_front(header.name(), header)
6464
}
6565

66-
/// Inserts `header` using its [`InsertIntoHeaders`] implementation to the front of the list
66+
/// Inserts `header` using its [`ExtendValues`] implementation to the front of the list
6767
#[inline]
6868
pub fn insert_type_front<H: ExtendValues + ?Sized>(&mut self, name: Name, header: &H) {
6969
let ctx = PrintCtx::default();

sip/sip-types/src/header/mod.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ pub use error::HeaderError;
1919

2020
/// Assign a constant header name to a type.
2121
///
22-
/// Is used by [`Headers`]'s `(get/take)_named` API so no
22+
/// Is used by [`Headers`](headers::Headers)'s `(get/take)_named` API so no
2323
/// name has to be provided by the caller.
2424
pub trait ConstNamed {
2525
const NAME: Name;
2626
}
2727

28-
/// Decode a header from one or more values. Used to parse headers from [`Headers`].
28+
/// Decode a header from one or more values. Used to parse headers from [`Headers`](headers::Headers).
2929
pub trait DecodeValues: Sized {
3030
/// Decode a header from a iterator of [`BytesStr`].
3131
///
@@ -44,7 +44,7 @@ pub trait HeaderParse: Sized {
4444
// ==== PRINT TRAITS ====
4545

4646
/// Assign a dynamic header name to a type.
47-
/// Used for [`Headers`]'s `insert_named(_front)` API.
47+
/// Used for [`Headers`](headers::Headers)'s `insert_named(_front)` API.
4848
///
4949
/// Can be used for enum holding different header variants.
5050
pub trait DynNamed {
@@ -57,7 +57,7 @@ impl<T: ConstNamed> DynNamed for T {
5757
}
5858
}
5959

60-
/// Insert a header type into [`Header`].
60+
/// Insert a header type into [`Header`](headers::Headers).
6161
pub trait ExtendValues {
6262
/// Called when there already existing values.
6363
///
@@ -67,7 +67,7 @@ pub trait ExtendValues {
6767

6868
/// Called when there are no existing values.
6969
///
70-
/// Must generate header value to be inserted into [`Headers`].
70+
/// Must generate header value to be inserted into [`Headers`](headers::Headers).
7171
fn create_values(&self, ctx: PrintCtx<'_>) -> OneOrMore;
7272
}
7373

sip/sip-types/src/header/typed/auth.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -517,12 +517,12 @@ impl Display for Algorithm {
517517
}
518518

519519
/// AKA versions
520-
/// https://www.iana.org/assignments/aka-version-namespace/aka-version-namespace.xhtml
520+
/// <https://www.iana.org/assignments/aka-version-namespace/aka-version-namespace.xhtml>
521521
#[derive(Debug, Clone, PartialEq, Eq)]
522522
pub enum AkaVersion {
523-
/// https://datatracker.ietf.org/doc/html/rfc3310
523+
/// <https://datatracker.ietf.org/doc/html/rfc3310>
524524
AKAv1,
525-
/// https://datatracker.ietf.org/doc/html/rfc4169
525+
/// <https://datatracker.ietf.org/doc/html/rfc4169>
526526
AKAv2,
527527
Other(BytesStr),
528528
}

sip/sip-types/src/header/typed/from_to.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ use nom::combinator::map;
1010
use nom::sequence::tuple;
1111
use std::fmt;
1212

13-
/// Type which is being wrapped by [From] and [To]
13+
/// Type which represent the `From` and `To` header value
1414
#[derive(Debug, Clone)]
1515
pub struct FromTo {
1616
pub uri: NameAddr,

0 commit comments

Comments
 (0)