Struct gdnative_doc::backend::Generator

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

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

opening_comment: bool

Control if an opening comment with meta-information should ba added to generated files.

See ConfigFile::opening_comment

Implementations

impl<'a> Generator<'a>

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

Generate the root documentation file of the crate.

The following will be generated (in markdown style):

<crate documentation>


<list of GDNative classes>

This then uses Callbacks::encode to encode this in the target format.

pub fn generate_file(
    &self,
    name: &str,
    class: &GdnativeClass,
    callbacks: &mut dyn Callbacks
) -> String

Generate the documentation for a class.

The following will be generated (in markdown style):

**Inherit:** <inherited class>

# Description

<class documentation>

# Properties

<table of class properties>

# Methods

<table of class methods>

# Properties Descriptions

<list of the class properties with their documentation>

# Methods Descriptions

<list of the class methods with their documentation>

This then uses Callbacks::encode to encode this in the target format.

Trait Implementations

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

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

Formats the value using the given formatter.