bird_tool_utils-man 0.4.0

(fork of man crate) 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

use crate::{Flag, FlagOrOption, Opt};

/// Add a custom section
#[derive(Debug)]
pub struct Section {
  pub(crate) name: String,
  pub(crate) paragraphs: Vec<String>,
  pub(crate) flags_and_options: Vec<Box<dyn FlagOrOption>>,
}

impl Section {
  pub fn new(name: &str) -> Self {
    Self {
      name: name.into(),
      paragraphs: vec![],
      flags_and_options: vec![],
    }
  }

  pub fn paragraph(mut self, text: &str) -> Self {
    self.paragraphs.push(text.into());
    self
  }

  /// Add an flag.
  pub fn flag(mut self, flag: Flag) -> Self {
    self.flags_and_options.push(Box::new(flag));
    self
  }

  /// Add an option.
  pub fn option(mut self, opt: Opt) -> Self {
    self.flags_and_options.push(Box::new(opt));
    self
  }
}