From c94515cd108fa6fd26702df321e68ca9538b589f Mon Sep 17 00:00:00 2001 From: Patrick McDermott Date: Wed, 13 Mar 2019 20:59:30 -0400 Subject: ob_get_doc_package(): Document --- diff --git a/lib/package.sh b/lib/package.sh index 44fd858..c6979d7 100644 --- a/lib/package.sh +++ b/lib/package.sh @@ -205,6 +205,13 @@ ob_get_binary_parameter() return 0 } +## @brief Get the documentation-providing binary package +## @details \fBob_get_doc_package\fP gets the name of the binary package that +## will provide documentation files about the source package. +## @return Returns 0 on success or 1 if no or multiple packages are found to +## provide documentation files. +## @stdout Prints the documentation-providing binary package name. +## @pure yes This function has no side effects. ob_get_doc_package() { _ob_package_do 'get_doc_package' || return ${?} -- cgit v0.9.1