Trait starlark::docs::markdown::RenderMarkdown

pub trait RenderMarkdown {
    // Required method
    fn render_markdown_opt(&self, flavor: MarkdownFlavor) -> Option<String>;

    // Provided method
    fn render_markdown(&self, flavor: MarkdownFlavor) -> String { ... }
}

This object can potentially generate markdown documentation about itself.

Required Methods

fn render_markdown_opt(&self, flavor: MarkdownFlavor) -> Option<String>

Generate markdown of the given flavor if possible. For some types, there may not be any useful documentation available.

Provided Methods

fn render_markdown(&self, flavor: MarkdownFlavor) -> String

Convenience method that invokes RenderMarkdown::render_markdown_opt, and returns an empty string if that is None

Implementations on Foreign Types

impl RenderMarkdown for str

fn render_markdown_opt(&self, _flavor: MarkdownFlavor) -> Option<String>

impl RenderMarkdown for String

fn render_markdown_opt(&self, _flavor: MarkdownFlavor) -> Option<String>

Implementors

impl RenderMarkdown for Doc