Struct Documentation

pub struct Documentation {
    pub namespace: String,
    pub name: String,
    pub sub_modules: Vec<Documentation>,
    pub documentation: String,
    pub items: Vec<Item>,
}

Rhai module documentation parsed from a definitions exported by a rhai engine.

Fields

namespace: String

Complete path to the module.

name: String

Name of the module.

sub_modules: Vec<Documentation>

Sub modules.

documentation: String

Module documentation as raw text.

items: Vec<Item>

Documentation items found in the module.

Trait Implementations

impl Clone for Documentation

fn clone(&self) -> Documentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documentation

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

Formats the value using the given formatter.