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 { ... }
}
Expand description
Trait added by using derive(ReferenceDoc)]
.
Required Methods§
sourcefn get_reference_doc_markdown() -> String
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§
sourcefn get_reference_doc_markdown_with_options(
indent_headers_by: usize,
indent_with_spaces: usize
) -> String
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.
Object Safety§
This trait is not object safe.