Struct ModuleDoc 

pub struct ModuleDoc {
    pub name: String,
    pub description: String,
    pub functions: Vec<FunctionDoc>,
    pub examples: Vec<String>,
}

Documentation for a single module

Fields

name: String

Module name

description: String

Module description

functions: Vec<FunctionDoc>

Function documentation for this module

examples: Vec<String>

Module-level examples

Implementations

impl ModuleDoc

pub fn new(name: impl Into<String>, description: impl Into<String>) -> Self

Create a new module documentation entry

pub fn add_function(&mut self, function: FunctionDoc)

Add a function to this module’s documentation

pub fn add_example(&mut self, example: impl Into<String>)

Add an example to this module

Trait Implementations

impl Clone for ModuleDoc

fn clone(&self) -> ModuleDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModuleDoc

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

Formats the value using the given formatter.

impl Serialize for ModuleDoc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.