summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPatrick McDermott <patrick.mcdermott@libiquity.com>2018-12-27 20:30:38 (EST)
committer Patrick McDermott <patrick.mcdermott@libiquity.com>2018-12-27 20:30:38 (EST)
commitc7c398f80670c7597f775f4f5b05c524d461c18d (patch)
treeadb4bb383c33f358532a344a5d4cbd2293e27123
parentcfdf75fad1f8b39a64395c107eb112384090413c (diff)
ob_error(), ob_warn(), ob_info(): Note preceding text in @stderr doc cmd
-rw-r--r--lib/output.sh9
1 files changed, 6 insertions, 3 deletions
diff --git a/lib/output.sh b/lib/output.sh
index ae76fd0..0e141ac 100644
--- a/lib/output.sh
+++ b/lib/output.sh
@@ -26,7 +26,8 @@
## \fIformat\fP.
## @return This function does not return. It causes the application to exit
## with an exit status of 1.
-## @stderr This function prints the formatted error message to stderr.
+## @stderr This function prints the formatted message, preceded by the program
+## name and "Error:", to stderr.
## @pure no This function causes the current shell to exit.
ob_error()
{
@@ -44,7 +45,8 @@ ob_error()
## @operand arguments opt Arguments to be printed, as referenced by
## \fIformat\fP.
## @return Returns 0 on success or 125 if \fIformat\fP is missing.
-## @stderr This function prints the formatted warning message to stderr.
+## @stderr This function prints the formatted message, preceded by the program
+## name and "Warning:", to stderr.
## @pure yes This function has no side effects.
ob_warn()
{
@@ -66,7 +68,8 @@ ob_warn()
## @operand arguments opt Arguments to be printed, as referenced by
## \fIformat\fP.
## @return Returns 0 on success or 125 if \fIformat\fP is missing.
-## @stderr This function prints the formatted informational message to stderr.
+## @stderr This function prints the formatted message, preceded by the program
+## name, to stderr.
## @pure yes This function has no side effects.
ob_info()
{