Struct Docs 

pub struct Docs {
    pub module: String,
    pub digest: String,
    pub types: Vec<TypeEntry>,
    pub items: Vec<Entry>,
}

A module’s reference documentation.

Fields

module: String

digest: String

The interface digest this page was generated from — the same value crate::iface::Interface::digest publishes, so a page can be matched to a contract.

types: Vec<TypeEntry>

items: Vec<Entry>

Implementations

impl Docs

pub fn of(program: &Program) -> Docs

Derive a module’s documentation from the checked, placed program.

pub fn of_interface( iface: &Interface, comments: &BTreeMap<Arc<str>, Arc<str>>, ) -> Docs

The page for an interface that has already been computed.

A module that imports another is checked as part of a project, and the program that comes out of the slicer is every module merged — which is right for slicing and wrong for a documentation page, because beck doc on one module would then publish the names of every module beneath it. Project::interface is the root module’s own contract, and it is what a page is of. docs/56 §56.5 is where that was found.

The doc-comment map is the program’s, because a comment is looked up by the name it documents and the interface selects which names those are.

pub fn documented(&self) -> (usize, usize)

How many published names carry a doc comment, and how many there are.

Reported rather than enforced: a coverage gate that fails a build is how a codebase ends up with ## the id on a field called id. The number is here so it can be looked at.

impl Docs

pub fn to_markdown(&self) -> String

Markdown — the form that is checked in and diffed.

pub fn to_json(&self) -> String

JSON — the form a tool consumes. Hand-written rather than derived, so the shape is a decision in this file rather than a consequence of the Rust field names.

impl Docs

pub fn to_html(&self, repo: Option<&str>) -> String

HTML — the form that is published. repo is page’s: the repository to link back to.

Trait Implementations

impl Clone for Docs

fn clone(&self) -> Docs

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Docs

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Docs

fn default() -> Docs

Returns the “default value” for a type.

impl PartialEq for Docs

fn eq(&self, other: &Docs) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Docs

impl StructuralPartialEq for Docs