pub struct TsDocParser {
pub extensions: TsDocExtensions,
}Expand description
@acp:summary “TSDoc parser with full TSDoc support” @acp:lock normal
Fields§
§extensions: TsDocExtensionsTSDoc extensions parsed from comments
Implementations§
Source§impl TsDocParser
impl TsDocParser
Sourcepub fn extensions(&self) -> &TsDocExtensions
pub fn extensions(&self) -> &TsDocExtensions
@acp:summary “Gets the parsed TSDoc extensions”
Trait Implementations§
Source§impl Default for TsDocParser
impl Default for TsDocParser
Source§impl DocStandardParser for TsDocParser
impl DocStandardParser for TsDocParser
Source§fn parse(&self, raw_comment: &str) -> ParsedDocumentation
fn parse(&self, raw_comment: &str) -> ParsedDocumentation
@acp:summary “Parses a raw doc comment into structured documentation”
Source§fn standard_name(&self) -> &'static str
fn standard_name(&self) -> &'static str
@acp:summary “Gets the standard name”
Source§fn to_suggestions(
&self,
parsed: &ParsedDocumentation,
target: &str,
line: usize,
) -> Vec<Suggestion>
fn to_suggestions( &self, parsed: &ParsedDocumentation, target: &str, line: usize, ) -> Vec<Suggestion>
@acp:summary “Converts parsed documentation to ACP suggestions” Read more
Auto Trait Implementations§
impl Freeze for TsDocParser
impl RefUnwindSafe for TsDocParser
impl Send for TsDocParser
impl Sync for TsDocParser
impl Unpin for TsDocParser
impl UnwindSafe for TsDocParser
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more