Struct dia_args::docs::Docs

pub struct Docs<'a> {
    pub name: Cow<'a, str>,
    pub docs: Cow<'a, str>,
    pub cfg: Cfg,
    pub i18n: I18n<'a>,
    pub options: Option<Vec<Cow<'a, Option<'a>>>>,
    pub commands: Option<Vec<Cow<'a, Cmd<'a>>>>,
    pub project: Option<Project<'a>>,
}

Documentation

Fields

name: Cow<'a, str>

Name

docs: Cow<'a, str>

Documentation

cfg: Cfg

Configuration

i18n: I18n<'a>

Internatinonalization

options: Option<Vec<Cow<'a, Option<'a>>>>

Options

commands: Option<Vec<Cow<'a, Cmd<'a>>>>

Commands

project: Option<Project<'a>>

Project

Implementations

impl<'a> Docs<'a>

pub fn new(name: Cow<'a, str>, docs: Cow<'a, str>) -> Self

Makes new instance with default configurations

pub fn print(self) -> Result<()>

Prints this documentation to stdout

Trait Implementations

impl Display for Docs<'_>

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

Formats the value using the given formatter.