From 13a73dd8ee1d0d518e781a5ea06f1ff4e7aff4ed Mon Sep 17 00:00:00 2001
From: P. J. McDermott <pjm@nac.net>
Date: Wed, 01 Aug 2012 02:24:23 -0400
Subject: Clean up comments in messages library.

---
(limited to 'lib')

diff --git a/lib/messages.sh b/lib/messages.sh
index c2c381e..b2d3a2a 100644
--- a/lib/messages.sh
+++ b/lib/messages.sh
@@ -19,13 +19,9 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-# Prints an error message and exits.
-# Parameters:
-#   message
-# Output:
-#   message
-# Return value:
-#   none
+# TODO: Which of these should print to the standard error stream – just
+# oh_error() and oh_warn()?
+
 oh_error()
 {
 	printf '%s: Error: ' "${0##*/}"
@@ -34,13 +30,6 @@ oh_error()
 	exit 1
 }
 
-# Prints a warning message.
-# Parameters:
-#   message
-# Output:
-#   message
-# Return value:
-#   0
 oh_warn()
 {
 	printf '%s: Warning: ' "${0##*/}"
@@ -49,13 +38,6 @@ oh_warn()
 	return 0
 }
 
-# Prints an informational message.
-# Parameters:
-#   message
-# Output:
-#   message
-# Return value:
-#   0
 oh_info()
 {
 	printf '%s: ' "${0##*/}"
--
cgit v0.9.1