diff options
| author | Patrick McDermott <patrick.mcdermott@libiquity.com> | 2018-12-28 11:02:37 (EST) |
|---|---|---|
| committer | Patrick McDermott <patrick.mcdermott@libiquity.com> | 2018-12-28 11:02:37 (EST) |
| commit | bc7ef86dd7cea1d78a397a0ca9c142c17bc0b9c2 (patch) | |
| tree | d7b97850345f3effd45d93d5df26a2957221c0d8 /lib | |
| parent | b3ea7544f7a32949499b331fb51622569974ad2b (diff) | |
ob_get_msg(): Document
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/locale.sh | 7 |
1 files changed, 7 insertions, 0 deletions
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= |