ob_set_substvar(): Document

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=