bashdoc

BashDoc

A tool for generating documentation/help menu for ~~user defined bash functions~~ any folder or file with 6 generic delimiters defined.

Syntax

Example

Using syntax similar to below

```bash

;

cd()

moves to given directory

@param directory: folder to move to

@return void

"

cd() { cd $1 } ```

on my zshrc Outputs

with lots of color!

Global Delimiters

The default delimiters to use are as follows:

START_DELIM = #;

END_DELIM = #"

PAR_DELIM = @param

RET_DELIM = @return

OPT_DELIM = # -

COMM_DELIM = #

These can be modifed in your .bashdocrc.

Install

bash cargo install bashdoc

or from source

NOTE: Must use Rust 2018 Edition

update with rustup update stable

bash git clone https://github.com/dustinknopoff/bashdoc cd bashdoc cargo install --path . --force

Usage

```bash bashdoc 0.4.10 Creates a "javadoc" like structure for bash. See github repo github.com/dustinknopoff/bashdoc for information on formatting.

USAGE: bashdoc [FLAGS] [OPTIONS] [SUBCOMMAND]

FLAGS: -c, --color toggles color -h, --help Prints help information -V, --version Prints version information -w, --watch continuously update on change

OPTIONS: -j, --json print result as JSON -l, --location location to save HTML -t, --template