Skip to content
GitLab
Explore
Sign in
Commits on Source (2)
shell-docs-gen.sh, fix regression for STDOUT output
· bee82947
Andreas Unterkircher
authored
Nov 11, 2017
bee82947
prepare v1.6.1 release
· c58ed113
Andreas Unterkircher
authored
Nov 11, 2017
c58ed113
Show whitespace changes
Inline
Side-by-side
CHANGELOG.md
View file @
c58ed113
# Changes in shell-docs-generator
## 1.6.1 (2017-11-11)
*
fix regression in STDOUT output mode (missing newlines)
## 1.6 (2017-11-11)
*
also scan variables (for now global ones only) for doc-stanzas
...
...
FUNCREF.md
View file @
c58ed113
...
...
@@ -3,7 +3,7 @@
| Tag | Value |
| - | - |
| Author | Andreas Unterkircher |
| Version | 1.6 |
| Version | 1.6
.1
|
| License | AGPLv3 |
<!-- if a table-of-contents gets actually rendered, depends on your markdown-viewer -->
...
...
@@ -684,4 +684,4 @@ filled by parse_input(). The output is stored in the $OUTPUT file.
| - | - |
| Type |
`int`
|
[
^1
]:
Created
by _shell-docs-gen.sh_ _v1.6_ on Sat Nov 11
09:36:57
UTC 2017.
[
^1
]:
Created
by _shell-docs-gen.sh_ _v1.6
.1
_ on Sat Nov 11
14:37:45
UTC 2017.
shell-docs-gen.sh
View file @
c58ed113
...
...
@@ -2,7 +2,7 @@
###############################################################################
# This file is part of the shell-docs-generator v1.6
# This file is part of the shell-docs-generator v1.6
.1
#
# shell-docs-generator, a documentation generator for shell scripts based on
# comment tags like @brief, @return, etc. that are placed in front of a
...
...
@@ -22,7 +22,7 @@
# @title shell-docs-generator
# @author Andreas Unterkircher
# @version 1.6
# @version 1.6
.1
# @license AGPLv3
set
-u
-e
-o
pipefail
# exit-on-error, error on undeclared variables.
...
...
@@ -41,7 +41,7 @@ readonly PROG_NAME="$(basename "${BASH_SOURCE[0]}")"
# @var PROG_VERS
# @description the scripts major and minor version numbers
readonly
PROG_VERS
=
"1.6"
readonly
PROG_VERS
=
"1.6
.1
"
# @var CODE_SRC
# @description index array, that helds the complete, read-in source code
...
...
@@ -602,7 +602,7 @@ mdout ()
# just echo to stdout
if
[
"
${
OUTPUT
}
"
==
'-'
]
;
then
printf
'%b'
"
${
1
}
"
printf
'%b
\n
'
"
${
1
}
"
return
0
fi
...
...
@@ -1323,6 +1323,6 @@ parse_input || \
output_markdown
||
\
{
fail
"output_markdown() exited non-zero! Exiting."
;
exit
1
;
}
if
[
"
${
OUTPUT
}
"
=
=
'-'
]
||
is_verbose
;
then
if
is_verbose
&&
[
"
${
OUTPUT
}
"
!
=
'-'
]
;
then
cat
"
${
OUTPUT
}
"
fi