From bc7ef86dd7cea1d78a397a0ca9c142c17bc0b9c2 Mon Sep 17 00:00:00 2001
From: Patrick McDermott <patrick.mcdermott@libiquity.com>
Date: Fri, 28 Dec 2018 11:02:37 -0500
Subject: ob_get_msg(): Document

---
(limited to 'lib')

diff --git a/lib/locale.sh b/lib/locale.sh
index 8196203..58f61db 100644
--- a/lib/locale.sh
+++ b/lib/locale.sh
@@ -120,6 +120,13 @@ ob_set_locale_path()
 	return 0
 }
 
+## @brief Get a message from the current message domain
+## @details \fBob_get_msg\fP prints a message, identified by a message ID, from
+##          the currently loaded message catalog.
+## @operand msgid req The ID of the message to print
+## @return Returns 0 on success or 125 if \fImsgid\fP is missing.
+## @stdout Prints the requested message from the current message domain.
+## @pure yes This function has no side effects.
 ob_get_msg()
 {
 	local msgid=
--
cgit v0.9.1