Struct deno_doc::DocParser

pub struct DocParser<'a> {
    pub graph: ModuleGraph,
    pub private: bool,
    pub store: &'a dyn ParsedSourceStore,
}

Fields

graph: ModuleGraph

private: bool

store: &'a dyn ParsedSourceStore

Implementations

impl<'a> DocParser<'a>

pub fn new(
    graph: ModuleGraph,
    private: bool,
    store: &'a dyn ParsedSourceStore
) -> Self

pub fn parse_module(
    &self,
    specifier: &ModuleSpecifier
) -> 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 fn parse(
    &self,
    specifier: &ModuleSpecifier
) -> Result<Vec<DocNode>, DocError>

Fetches file_name and returns a list of exported items (no reexports).

pub fn parse_with_reexports(
    &self,
    specifier: &ModuleSpecifier
) -> Result<Vec<DocNode>, DocError>

Fetches file_name, parses it, and resolves its reexports.

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

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

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

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