DocStandardParser

Trait DocStandardParser 

Source
pub trait DocStandardParser: Send + Sync {
    // Required methods
    fn parse(&self, raw_comment: &str) -> ParsedDocumentation;
    fn standard_name(&self) -> &'static str;

    // Provided method
    fn to_suggestions(
        &self,
        parsed: &ParsedDocumentation,
        target: &str,
        line: usize,
    ) -> Vec<Suggestion> { ... }
}
Expand description

@acp:summary “Trait for parsing language-specific doc standards”

Required Methods§

Source

fn parse(&self, raw_comment: &str) -> ParsedDocumentation

@acp:summary “Parses a raw doc comment into structured documentation”

Source

fn standard_name(&self) -> &'static str

@acp:summary “Gets the standard name”

Provided Methods§

Source

fn to_suggestions( &self, parsed: &ParsedDocumentation, target: &str, line: usize, ) -> Vec<Suggestion>

@acp:summary “Converts parsed documentation to ACP suggestions”

Default implementation converts common fields to suggestions. Override for standard-specific behavior.

Implementors§