shelldoc/examples/simple at master · charlesdaniels/shelldoc · GitHub

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
#!/bin/sh

# .SCRIPTDOC

# Script synopsis goes here

# .DESCRIPTION

# detailed script description goes here

# * this is a bulleted list
#   + This item is indented
# * this item is not indented

# .SYNTAX

#   $1 . . . description of first argument
#
#   $2 . . . description of second argument
#
#   $@ . . . description of remaining arguments

# .LICENSE

# script license goes here

# .CHANGELOG

# script chagenlog goes here

# .AUTHOR

# script authors go here

# .ENDOC


# .DOCUMENTS hello

# this is the synopsis

# .DESCRIPTION

# this is a detailed description of the function

# .SYNTAX
#
#    $1 . . . description of first argument
#
#    $2 . . . description of second argument
#
#    $@ . . . description of remaining arguments

# .ENDOC

hello () {
    echo Hello!
}