Description

Rustdoc1 is the built in library documentation tool included in the Rust distribution and allows you to write documentation in Markdown2.

Syntax

pub mod foo {
    /// Some docs for `Foo`
    ///
    /// You may want to use `Foo` with [`Bar`].
    ///
    /// [`Bar`]: ../bar/struct.Bar.html
    pub struct Foo;
}
 
pub mod bar {
    /// Some docs for `Bar`
    ///
    /// You may want to use `Bar` with [`Foo`].
    ///
    /// [`Foo`]: ../foo/struct.Foo.html
    pub struct Bar;
}

Footnotes

Footnotes

  1. https://doc.rust-lang.org/rustdoc/index.html

  2. https://en.wikipedia.org/wiki/Markdown