diff options
| -rw-r--r-- | lib/output.sh | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/output.sh b/lib/output.sh index 7f5e54f..ae76fd0 100644 --- a/lib/output.sh +++ b/lib/output.sh @@ -37,6 +37,15 @@ ob_error() exit 1 } +## @brief Print a warning message +## @details \fBob_warn\fP prints \fIarguments\fP according to \fIformat\fP. +## @operand format req The format string. See \fBprintf\fP(1) for the syntax +## of \fIformat\fP. +## @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. +## @pure yes This function has no side effects. ob_warn() { if [ ${#} -eq 0 ]; then @@ -50,6 +59,15 @@ ob_warn() return 0 } +## @brief Print an informational message +## @details \fBob_warn\fP prints \fIarguments\fP according to \fIformat\fP. +## @operand format req The format string. See \fBprintf\fP(1) for the syntax +## of \fIformat\fP. +## @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. +## @pure yes This function has no side effects. ob_info() { if [ ${#} -eq 0 ]; then |