From c4d516e6b4c79502450a008da681dcea365e51d3 Mon Sep 17 00:00:00 2001 From: Patrick McDermott Date: Wed, 13 Mar 2019 20:52:43 -0400 Subject: ob_get_*_parameter(): Document --- (limited to 'lib/package.sh') diff --git a/lib/package.sh b/lib/package.sh index c684cc5..44fd858 100644 --- a/lib/package.sh +++ b/lib/package.sh @@ -141,6 +141,13 @@ ob_get_binary_packages() return 0 } +## @brief Get a source package field value +## @details \fBob_get_source_parameter\fP gets the value of a source package +## field. +## @operand name The name of the field. +## @return Returns 0 on success or 1 if \fIname\fP is invalid. +## @stdout Prints the source package field value. +## @pure yes This function has no side effects. ob_get_source_parameter() { local name="${1}" @@ -160,6 +167,14 @@ ob_get_source_parameter() return 0 } +## @brief Get a binary package field value +## @details \fBob_get_binary_parameter\fP gets the value of a binary package +## field. +## @operand package The name of the binary package. +## @operand name The name of the field. +## @return Returns 0 on success or 1 if \fIname\fP is invalid. +## @stdout Prints the binary package field value. +## @pure yes This function has no side effects. ob_get_binary_parameter() { local package="${1}" -- cgit v0.9.1