Struct gdnative_doc::Builder

pub struct Builder { /* fields omitted */ }

A builder for generating godot documentation in various formats.

Implementations

impl Builder

pub fn new() -> Self

Create a default Builder with no backends.

pub fn user_config(mut self: Self, path: PathBuf) -> Self

Set configuration options according to the file at path.

See the ConfigFile documentation for information about the configuration file format.

pub fn package(mut self: Self, package: Package) -> Self

Specify the crate to document.

This can be either the name of the crate, or directly the path of the root file.

pub fn add_backend(mut self: Self, backend: Backend) -> Self

Add a new backend to the builder.

pub fn add_backend_with_callbacks(
    mut self: Self,
    backend: Backend,
    callbacks: Box<dyn Callbacks>
) -> Self

Add a new backend to the builder, with custom callbacks encoding functions.

pub fn build(mut self: Self) -> Result<()>

Build the documentation.

This will generate the documentation for each specified backend, creating the ouput directories if needed.

Trait Implementations

impl Debug for Builder

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

Formats the value using the given formatter.