Struct rhai_autodocs::module::options::Options

pub struct Options { /* private fields */ }

Options to configure documentation generation.

Implementations

impl Options

pub fn include_standard_packages(self, include_standard_packages: bool) -> Self

Include the standard package functions and modules documentation in the generated documentation markdown.

pub fn order_items_with(self, items_order: ItemsOrder) -> Self

Order documentation items in a specific way. See ItemsOrder for more details.

pub fn format_sections_with(self, sections_format: SectionFormat) -> Self

Format doc comments ‘sections’, markdown that starts with the # character, with special formats. See SectionFormat for more details.

pub fn generate( self, engine: &Engine ) -> Result<ModuleDocumentation, AutodocsError>

Generate documentation based on an engine instance. Make sure all the functions, operators, plugins, etc. are registered inside this instance.

Result

• A vector of documented modules.

Errors

• Failed to generate function metadata as json.
• Failed to parse module metadata.

pub fn generate_with_glossary( &self, engine: &Engine ) -> Result<(ModuleDocumentation, ModuleGlossary), AutodocsError>

Generate documentation based on an engine instance and a list of all functions signature. Make sure all the functions, operators, plugins, etc. are registered inside this instance.

Result

• A vector of documented modules and the glossary.

Errors

• Failed to generate function metadata as json.
• Failed to parse module metadata.

Trait Implementations

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.