reconquest / shdoc

Documentation generator for shell scripts (bash, sh, zsh). Javadoc for shell scripts.
MIT License
294 stars 63 forks source link

Add support for sections in the doc #53

Closed Ariana-Hlavaty-i2 closed 2 years ago

Ariana-Hlavaty-i2 commented 2 years ago

The ability to add sections to group together functions.

For example if a script looks like:

  # @section Section A
  # @description a
  # a

  # @description func a
  # line a 2
  a() {
  }

  # @section Section B
  # @description b

  # @description func b
  # ab
  b() {
  }

the generated md file would look like:

## Section A

a
a

### a

func a
line a 2

## Section B

b

### b

func b
ab