pub struct Builder { /* private fields */ }
Expand description

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.


Create a default Builder with no backends.

Set user configuration options.

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

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.

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

Add a new builtin backend to the builder.

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

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

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

Build the documentation.

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

Trait Implementations

Formats the value using the given formatter. Read more
Returns the “default value” for a type. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.