Fix rustdoc links in lib/scanner & lib/token #37

Merged
bazaah merged 1 commit from docs/fix-rustdoc-links into master 2023-06-22 15:32:33 +00:00
3 changed files with 6 additions and 7 deletions

View file

@ -924,7 +924,7 @@ impl Scanner
} }
/// Chomp whitespace and optionally comments until we /// Chomp whitespace and optionally comments until we
/// reach the next token, updating buffer[0] to the /// reach the next token, updating .buffer to the
/// beginning of the new token /// beginning of the new token
fn eat_whitespace(&mut self, opts: Flags, buffer: &mut &str, comments: bool) -> Result<usize> fn eat_whitespace(&mut self, opts: Flags, buffer: &mut &str, comments: bool) -> Result<usize>
{ {

View file

@ -430,8 +430,7 @@ where
} }
} }
/// Helper function for constructing /// Helper function for constructing [Token::Tag](Token)s
/// [Ref][Ref]<[Token::Tag][Token]>s
fn assemble_tag<'de>(handle: &'de str, suffix: Slice<'de>, can_borrow: bool) -> Token<'de> fn assemble_tag<'de>(handle: &'de str, suffix: Slice<'de>, can_borrow: bool) -> Token<'de>
{ {
if can_borrow if can_borrow

View file

@ -11,9 +11,9 @@ pub type Slice<'a> = std::borrow::Cow<'a, str>;
pub enum Token<'a> pub enum Token<'a>
{ {
/// The stream's start, with the byte (encoding) /// The stream's start, with the byte (encoding)
/// [virtual] /// {virtual}
StreamStart(StreamEncoding), StreamStart(StreamEncoding),
/// The stream's end [virtual] /// The stream's end {virtual}
StreamEnd, StreamEnd,
/// The %YAML directive, (major,minor) /// The %YAML directive, (major,minor)
VersionDirective(u8, u8), VersionDirective(u8, u8),
@ -99,9 +99,9 @@ impl<'a> Token<'a>
pub enum Marker pub enum Marker
{ {
/// The stream's start, with the byte (encoding) /// The stream's start, with the byte (encoding)
/// [virtual] /// {virtual}
StreamStart, StreamStart,
/// The stream's end [virtual] /// The stream's end {virtual}
StreamEnd, StreamEnd,
/// The %YAML directive, (major,minor) /// The %YAML directive, (major,minor)
VersionDirective, VersionDirective,