ob_get_doc_files(): Document

1 files changed, 8 insertions, 0 deletions

diff --git a/lib/package.sh b/lib/package.sh
index 09f700e..487d333 100644
--- a/lib/package.sh
+++ b/lib/package.sh
@@ -219,6 +219,14 @@ ob_get_doc_package()
 	return 0
 }
 
+## @brief Get the source package documentation files table
+## @details \fBob_get_doc_files\fP gets the table of source package
+##          documentation files.  The table consists of lines of space-separated
+##          source (relative to the build work area) and destination (relative
+##          to the source package documentation directory) file paths.
+## @return Returns 0 on success.
+## @stdout Prints the source package documentation files table.
+## @pure yes This function has no side effects.
 ob_get_doc_files()
 {
 	_ob_package_do 'get_doc_files' || return ${?}