Struct DocGen 

pub struct DocGen { /* private fields */ }

A strucuture of documentation generator.

The documentation generator generates a documentation in a documentation directory of library. The documentation tree is used to a documentation generation by the documentation generator.

Implementations

impl DocGen

pub fn new<P: AsRef<Path>>(doc_dir: PathBuf, lib_path: P) -> Self

Creates a documentation generator.

pub fn lib_name(&self) -> &str

Returns the library name.

pub fn lib_doc_dir(&self) -> &Path

Returns the path to the documentation directory of library.

pub fn generate(&self, doc_tree: &DocTree) -> Result<()>

Generates a documnetation from the documentation tree.

Trait Implementations

impl Clone for DocGen

fn clone(&self) -> DocGen

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocGen

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

Formats the value using the given formatter.