Module gdnative_doc::backend[−][src]

Module for implementing your own backend.

To implement your own backend:

  1. Create a structure that represent your backend, and implement Callbacks on it.

    You can look in the source code of this crate to get examples of what that would look like.

  2. Add your backend to the Builder via the add_backend_with_callbacks method.

Re-exports

pub use crate::documentation::Documentation;

Structs

Generator

Holds the information necessary to generate the output files.

Resolver

Information to resolve links.

Enums

BuiltinBackend

Backend already implemented by this library.

Traits

Callbacks

Callbacks to encode markdown input in a given format.