Struct MarkdownWriter 

pub struct MarkdownWriter<W: Write> { /* private fields */ }

A DocumentationWriter that generates markdown documents.

Examples

See DocumentationWriter.

Implementations

impl<W: Write> MarkdownWriter<W>

pub fn new(w: W) -> Self

Create a new instance.

Trait Implementations

impl<W: Write> DocumentationWriter for MarkdownWriter<W>

type Error = Error

The error type returned by this writer.

fn set_title(&mut self, title: Cow<'static, str>)

Set the title of this document.

fn set_subtitle(&mut self, subtitle: Cow<'static, str>)

Set the subtitle of this document.

fn set_license(&mut self, license: Cow<'static, str>)

Set the license of this man page and/or the code it covers.

fn usage(&mut self, usage: &str) -> Result<(), Self::Error>

Emit usage information.

fn start_description(&mut self) -> Result<(), Self::Error>

Start the description section.

fn start_section(&mut self, name: &str) -> Result<(), Self::Error>

Start a custom section.

fn plain(&mut self, s: &str) -> Result<(), Self::Error>

Emit unformatted text.

fn paragraph_break(&mut self) -> Result<(), Self::Error>

Emit a paragraph break.

fn emphasis(&mut self, text: &str) -> Result<(), Self::Error>

Emit emphasized (italicized) text.

fn strong(&mut self, text: &str) -> Result<(), Self::Error>

Emit strong (bold) text.

fn link(&mut self, text: &str, to: &str) -> Result<(), Self::Error>

Emit a hyperlink.

fn start_options(&mut self) -> Result<(), Self::Error>

Start the options section.

fn option(&mut self, name: &str, default: &str) -> Result<(), Self::Error>

Emit an option.

fn start_environment(&mut self) -> Result<(), Self::Error>

Start the environment section.

fn variable(&mut self, name: &str, default: &str) -> Result<(), Self::Error>

Emit an environment variable.

fn start_enum(&mut self, name: &str) -> Result<(), Self::Error>

Start a custom enum section.

fn variant(&mut self, name: &str) -> Result<(), Self::Error>

Emit a enum variant.

fn finish(self) -> Result<(), Self::Error>

Finish the document by writing a footer.