Crate gdnative_doc

Generating documentation for gdnative.

Example

use gdnative_doc::{Backend, Builder, LevelFilter, init_logger};

init_logger(LevelFilter::Info)?;
Builder::new()
    .add_backend(Backend::Markdown {
        output_dir: "doc".into(),
    })
    .add_backend(Backend::Gut {
        output_dir: "addons/gut".into(),
    })
    .build()?;

Modules

documentation

Structures representing the documentation of a gdnative package.

Structs

Builder	A builder for generating godot documentation in various formats.
ConfigFile	Structure that holds user configuration settings.
Resolver	Information to resolve links.

Enums

Backend	Kind of files generated by a Builder.
Error	Type of errors emitted by this library.
LevelFilter	An enum representing the available verbosity level filters of the logger.
Package	Used to specify a crate in Builder::package.

Traits

Callbacks

Callbacks to encode markdown input in a given format.

Functions

init_logger

Initialize the logger with the specified logging level.

Type Definitions

Result