Function rhai_autodocs::glossary::generate_module_glossary

source · 
pub fn generate_module_glossary(
    engine: &Engine,
    options: &Options
) -> Result<ModuleGlossary, AutodocsError>
Expand description

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

CAUTION

This only works for docusaurus at the moment.

Result

  • A vector of documented modules.

Errors

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