From cfdf75fad1f8b39a64395c107eb112384090413c Mon Sep 17 00:00:00 2001
From: Patrick McDermott <patrick.mcdermott@libiquity.com>
Date: Thu, 27 Dec 2018 20:26:53 -0500
Subject: ob_warn(), ob_info(): Document

---
(limited to 'lib')

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
--
cgit v0.9.1