Crate gdnative_doc

Generating documentation for gdnative.

The goal of this library is to automatically generate documentation and gut tests from a gdnative project, that would still look good to Godot users.

You should either use this library in a build.rs script, using the Builder structure to drive the documentation generation:

use gdnative_doc::{backend::BuiltinBackend, init_logger, Builder, LevelFilter};
use std::path::PathBuf;

init_logger(LevelFilter::Info)?;
Builder::new()
    .add_backend(BuiltinBackend::Markdown, PathBuf::from("doc"))
    .add_backend(BuiltinBackend::Gut, PathBuf::from("addons/gut"))
    .build()?;

Or you can use the command-line tool.

Modules

backend

Module for implementing your own backend.

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.

Enums

Error

Type of errors emitted by this library.

GodotVersion

LevelFilter

An enum representing the available verbosity level filters of the logger.

Package

Used to specify a crate in Builder::package.

Functions

init_logger

Initialize the logger with the specified logging level.