bashdoc 0.6.0

A tool for generating documentation/help menu for user defined bash functions. 
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

about: 'Creates a "javadoc" like structure for bash. See github repo github.com/dustinknopoff/bashdoc for information on formatting.'
name: bashdoc
version: "0.5.1"
args:
  - color:
      help: "toggles color"
      long: color
      short: c
  - INPUT:
      help: "Sets the input file or glob pattern to use"
      index: 1
      required: true
  - json:
      help: "print result as JSON"
      long: json
      short: j
      takes_value: true
      value_name: FILE
  - watch:
      help: continuously update on change
      short: w
      long: watch
  - location:
      short: l
      long: location
      help: location to save HTML
      takes_value: true
  - template:
      short: t
      long: template
      help: .hbs template to use for generation of documentation
      takes_value: true
      requires: location
subcommands:
  - override:
      about: override the delimiters
      args:
        - start:
            short: s
            long: start
            help: delimiter for start
            takes_value: true
        - end:
            short: e
            long: end
            help: delimiter for start
            takes_value: true
        - descriptor:
            short: d
            long: desc
            help: delimiter for descriptors
            takes_value: true
        - params:
            short: p
            long: param
            help: delimiter for parameters
            takes_value: true
        - returns:
            short: r
            long: ret
            help: delimiter for return values
            takes_value: true
        - comment:
            short: c
            long: comment
            help: delimiter for comments
            takes_value: true