Struct deno_doc::parser::DocParser

pub struct DocParser {
    pub ast_parser: AstParser,
    pub loader: Box<dyn DocFileLoader>,
    pub private: bool,
}

Fields

ast_parser: AstParser

loader: Box<dyn DocFileLoader>

private: bool

Implementations

impl DocParser

pub fn new(loader: Box<dyn DocFileLoader>, private: bool) -> Self

pub fn parse_module(
    &self,
    file_name: &str,
    syntax: Syntax,
    source_code: &str
) -> Result<ModuleDoc, DocError>

Parses a module into a list of exported items, as well as a list of reexported items which need to be fetched from other modules.

pub async fn parse(&self, file_name: &str) -> Result<Vec<DocNode>, DocError>

Fetches file_name and parses it.

pub fn parse_source(
    &self,
    file_name: &str,
    syntax: Syntax,
    source_code: &str
) -> Result<Vec<DocNode>, DocError>

Parses a module and returns a list of exported items (no reexports).

pub fn parse_with_reexports<'a>(
    &'a self,
    file_name: &'a str
) -> LocalBoxFuture<'_, Result<Vec<DocNode>, DocError>>

Fetches file_name, parses it, and resolves its reexports.

pub fn get_doc_nodes_for_module_exports(
    &self,
    module_decl: &ModuleDecl
) -> Vec<DocNode>

pub fn get_doc_node_for_decl(&self, decl: &Decl) -> Option<DocNode>

pub fn get_reexports_for_module_body(
    &self,
    module_body: Vec<ModuleItem>
) -> Vec<Reexport>

pub fn get_doc_nodes_for_module_body(
    &self,
    module_body: Vec<ModuleItem>
) -> Vec<DocNode>

pub fn js_doc_for_span(&self, span: Span) -> Option<String>