Struct DocTreeGen 

pub struct DocTreeGen { /* private fields */ }

A structure of generator of documentation tree.

The generator of documentation tree takes a root module of documentation and then generates a documentation tree. A root module of signature are generated from the syntax tree while a generation of documentation tree. Applications of built-in function of running with documentation allows to documention generation from other files than the main file of library. By defaylt, the built-in function of running with documentation is runwithdoc.

Implementations

impl DocTreeGen

pub fn new_with_script_dir_and_run_with_doc_ident( doc_root_mod: Arc<RwLock<ModNode<String, Option<String>>>>, script_dir: PathBuf, run_with_doc_ident: String, ) -> Self

Creates a generator of documentation tree with the path to script directory and the identifier of built-in function of running with documentation.

Also, this method takes the root module of documentation that can have the module descriptions and the variable description.

pub fn new_with_script_dir( doc_root_mod: Arc<RwLock<ModNode<String, Option<String>>>>, script_dir: PathBuf, ) -> Self

Creates a generator of documentation tree with the path to script directory.

See new_with_script_dir_and_run_with_doc_ident.

pub fn new(doc_root_mod: Arc<RwLock<ModNode<String, Option<String>>>>) -> Self

Creates a generator of documentation tree.

See new_with_script_dir_and_run_with_doc_ident.

pub fn script_dir(&self) -> &Path

Returns the path to script directory.

pub fn run_with_doc_ident(&self) -> &str

Returns the identifier of built-in function of running with documentation.

pub fn generate(&mut self, tree: &Tree) -> Result<DocTree>

Generates a documentation tree from the syntax tree.

Trait Implementations

impl Clone for DocTreeGen

fn clone(&self) -> DocTreeGen

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocTreeGen

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.