From 64d141860f775779eb3a7c3c14a31f17d786760a Mon Sep 17 00:00:00 2001 From: Patrick McDermott Date: Fri, 28 Dec 2018 23:53:26 -0500 Subject: ob_set_substvar(): Document --- 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= -- cgit v0.9.1