summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorPatrick McDermott <patrick.mcdermott@libiquity.com>2018-12-29 01:00:51 (EST)
committer Patrick McDermott <patrick.mcdermott@libiquity.com>2018-12-29 01:00:51 (EST)
commitacb7d5599a6e1774633aa0c063915ba220bcd95e (patch)
treee098a58dd7dea7f3b94052e0961f1ea363bc0d91 /lib
parentec4f1c6409742f9f4bea0efef2c994c51e88c0c7 (diff)
ob_substvars(): Document
Diffstat (limited to 'lib')
-rw-r--r--lib/control.sh9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/control.sh b/lib/control.sh
index 53a3ea8..8f9fc26 100644
--- a/lib/control.sh
+++ b/lib/control.sh
@@ -242,6 +242,15 @@ ob_set_substvar()
return 0
}
+## @brief Substitute variables in text
+## @details \fBob_substvars\fP substitutes variables previously set with
+## \fBob_set_substvar\fP(3) in a string. The format for variable
+## substitutions is \fI${var}\fP, and substitutions can be nested.
+## @operand string req The string in which to substitute variables.
+## @return Returns 0 on success, 1 on possible recursion, or 125 if called with
+## an incorrect number of arguments.
+## @stderr Prints a warning on possible recursion.
+## @pure yes This function has no side effects.
ob_substvars()
{
local string=