ob_get_system_path(): Document

1 files changed, 15 insertions, 0 deletions

diff --git a/lib/metadata.sh b/lib/metadata.sh
index fd64a13..5628a18 100644
--- a/lib/metadata.sh
+++ b/lib/metadata.sh
@@ -329,6 +329,21 @@ ob_plat_is_concerned()
 	fi
 }
 
+## @brief Get a system path
+## @details \fBob_get_system_path\fP gets a system path consisting of \fIargs\fP
+##          formatted, by the metadata plugin selected at libopkbuild's build
+##          time, according to a path format identified by \fIpath_id\fP.  The
+##          arguments for a \fIpath_id\fP of either \fBpackage-source\fP or
+##          \fBpackage-docs\fP are \fIsource\fP and \fIversion\fP.  For
+##          \fBbuildflags\fP the argument is \fI arch\fP.  For \fBplatconf\fP
+##          they are \fIsource\fP, \fIversion\fP, and \fIplat\fP.
+## @operand path_id req One of \fBpackage-source\fP, \fBpackage-docs\fP,
+##                      \fBbuildflags\fP, or \fBplatconf\fP.
+## @operand args    req Additional arguments specific to each \fIpath_id\fP.
+## @return Returns 0 on success, or 125 if given an incorrect number of
+##         arguments.
+## @stdout Prints the requested path with \fIargs\fP.
+## @pure yes This function has no side effects.
 ob_get_system_path()
 {
 	local path_id=