Struct rhai_autodocs::module::ModuleDocumentation

pub struct ModuleDocumentation {
    pub namespace: String,
    pub name: String,
    pub sub_modules: Vec<ModuleDocumentation>,
    pub documentation: String,
    pub items: Vec<DocItem>,
}

Rhai module documentation in markdown format.

Fields

namespace: String

Complete path to the module.

name: String

Name of the module.

sub_modules: Vec<ModuleDocumentation>

Sub modules.

documentation: String

Module documentation as raw text.

items: Vec<DocItem>

Documentation items found in the module.

Trait Implementations

impl Debug for ModuleDocumentation

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

Formats the value using the given formatter.