Trait MarkdownReferenceDocGenerator

pub trait MarkdownReferenceDocGenerator {
    // Required method
    fn get_reference_doc_markdown() -> String;

    // Provided method
    fn get_reference_doc_markdown_with_options(
        indent_headers_by: usize,
        indent_with_spaces: usize,
    ) -> String { ... }
}

Trait added by using derive(ReferenceDoc)].

Required Methods

fn get_reference_doc_markdown() -> String

Returns a Markdown representation of the reference docs for the struct that is derived from ReferenceDoc. The returned Markdown indents any # Markdown headers in individual field doc comments to ensure a well structured final Markdown document.

Provided Methods

fn get_reference_doc_markdown_with_options( indent_headers_by: usize, indent_with_spaces: usize, ) -> String

This method is called internally by the reference doc generator when recursing to generate documentation for field types.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors