man 0.3.0

Generate structured man pages
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

/// Add a examples section
#[derive(Debug, Clone, Default)]
pub struct Example {
  pub(crate) prompt: &'static str,
  pub(crate) text: Option<&'static str>,
  pub(crate) command: Option<&'static str>,
  pub(crate) output: Option<&'static str>,
}

impl Example {
  pub fn new() -> Self {
    Self {
      prompt: "$",
      text: None,
      command: None,
      output: None,
    }
  }

  pub fn prompt(mut self, prompt: &'static str) -> Self {
    self.prompt = prompt;
    self
  }

  pub fn text(mut self, text: &'static str) -> Self {
    self.text = Some(text);
    self
  }

  pub fn command(mut self, command: &'static str) -> Self {
    self.command = Some(command);
    self
  }

  pub fn output(mut self, output: &'static str) -> Self {
    self.output = Some(output);
    self
  }
}