Struct gdnative_doc::Builder

pub struct Builder { /* fields omitted */ }

A builder for generating godot documentation in various formats.

For each format you want to generate, you must add a backend via add_backend or add_backend_with_callbacks.

Implementations

impl Builder

pub fn new() -> Self

Create a default Builder with no backends.

pub fn user_config(self, config: ConfigFile) -> Self

Set user configuration options.

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

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

Specify the crate to document.

The Builder will try to automatically determine which crate you want to document. If this fails or you are not satisfied with its guess, you can use this function to manually specify the crate you want to refer to.

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

Only one crate can be documented at a time: if this function is called multiple times, the last call will prevail.

Example

let builder = Builder::new().package(Package::Name("my-gdnative-crate".to_string()));

pub fn add_backend(self, backend: BuiltinBackend, output_dir: PathBuf) -> Self

Add a new builtin backend to the builder.

Example

let builder = Builder::new().add_backend(BuiltinBackend::Markdown, PathBuf::from("doc"));

pub fn add_backend_with_callbacks(
    self,
    callbacks: Box<dyn Callbacks>,
    output_dir: PathBuf
) -> Self

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

See the backend module for how to implement your own backend.

pub fn build(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.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.