summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorPatrick McDermott <patrick.mcdermott@libiquity.com>2018-12-28 23:53:26 (EST)
committer Patrick McDermott <patrick.mcdermott@libiquity.com>2018-12-28 23:53:26 (EST)
commit64d141860f775779eb3a7c3c14a31f17d786760a (patch)
tree5a13eb0cbcbd7dc7d9aa13152df2566509473fc0 /lib
parent31ba10dc5950fa1be5df0805aea2a24fc8685420 (diff)
ob_set_substvar(): 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 fcb649f..072f6e8 100644
--- a/lib/control.sh
+++ b/lib/control.sh
@@ -195,6 +195,15 @@ ${line# }"
return 0
}
+## @brief Set a substitution variable
+## @details \fBob_set_substvar\fP sets a substitution variable for later use by
+## \fBob_substvars\fP(3).
+## @operand name req The name of the substitution variable. May only consist
+## of uppercase and lowercase Latin letters, digits, and
+## hyphens and must be at least one character long.
+## @operand value req The value of the substitution variable.
+## @return Always returns 125. FIXME
+## @pure no This function sets an internal global variable.
ob_set_substvar()
{
local name=