Struct gdnative_doc::backend::Generator

pub struct Generator<'a> {
    pub resolver: &'a Resolver,
    pub documentation: &'a Documentation,
    pub markdown_options: MarkdownOptions,
}

Holds the information necessary to generate the output files.

This is used by structures implementing Callbacks.

Fields

resolver: &'a Resolver

Used to resolve links.

documentation: &'a Documentation

Holds the crate's documentation.

markdown_options: MarkdownOptions

Enabled markdown options

Implementations

impl<'a> Generator<'a>

pub fn generate_root_file(
    &mut self,
    extension: &str,
    callbacks: &mut dyn Callbacks
) -> String

Generate the root documentation file of the crate.

This is a decent default: it generate a description based on

pub fn generate_files(
    &mut self,
    callbacks: &mut dyn Callbacks
) -> Vec<(String, String)>

Generate pairs of (class_name, file_content).

Trait Implementations

impl<'a> Debug for Generator<'a>

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

Formats the value using the given formatter.