ob_set_package_substvars(): Document

1 files changed, 10 insertions, 0 deletions

diff --git a/lib/package.sh b/lib/package.sh
index fca1894..1b06d36 100644
--- a/lib/package.sh
+++ b/lib/package.sh
@@ -257,6 +257,16 @@ ob_get_doc_files()
 	return 0
 }
 
+## @brief Set package substitution variables
+## @details \fBob_set_package_substvars\fP() sets any substitution variables
+##          defined by a source package, as well as any standard substitution
+##          variables defined by the source package format, for later use by
+##          \fBob_substvars\fP(3).
+## @operand pkg req The binary package for which to set substitution variables
+##                  (currently ignored).
+## @return Returns 0 on success.
+## @stderr Prints error messages on parse errors.
+## @pure no This function sets internal global variables.
 ob_set_package_substvars()
 {
 	local pkg="${1}"