From cc369631ff8247040bb101c60a38bd227313c656 Mon Sep 17 00:00:00 2001
From: Patrick McDermott <patrick.mcdermott@libiquity.com>
Date: Thu, 14 Mar 2019 12:54:24 -0400
Subject: Fix missing "()" after function names in @details

Also fix function name in ob_get_system_plat()'s @details and update
ob_error()'s @details.
---
(limited to 'lib/package.sh')

diff --git a/lib/package.sh b/lib/package.sh
index 1b06d36..0b354e0 100644
--- a/lib/package.sh
+++ b/lib/package.sh
@@ -34,9 +34,9 @@ _ob_package_do()
 }
 
 ## @brief Initialize libopkbuild for a source package
-## @details \fBob_init_package\fP detects the version of and parses all metadata
-##          of a source package.  This function must be called before any other
-##          functions that operate on package metadata.
+## @details \fBob_init_package\fP() detects the version of and parses all
+##          metadata of a source package.  This function must be called before
+##          any other functions that operate on package metadata.
 ## @operand dir req The root directory of the source package.
 ## @return Returns 0 on success or 1 if the source package version can't be
 ##         detected or if the metadata can't be parsed.
@@ -70,7 +70,7 @@ ob_init_package()
 }
 
 ## @brief Get a list of binary packages
-## @details \fBob_get_binary_packages\fP finds a source package's binary
+## @details \fBob_get_binary_packages\fP() finds a source package's binary
 ##          packages, optionally filtering for packages that build for a certain
 ##          host architecture and/or platform.
 ## @option -a host_arch The architecture by which to filter binary packages.
@@ -165,7 +165,7 @@ ob_get_binary_packages()
 }
 
 ## @brief Get a source package field value
-## @details \fBob_get_source_parameter\fP gets the value of a source package
+## @details \fBob_get_source_parameter\fP() gets the value of a source package
 ##          field.
 ## @operand name req The name of the field.
 ## @return Returns 0 on success or 1 if \fIname\fP is invalid.
@@ -191,7 +191,7 @@ ob_get_source_parameter()
 }
 
 ## @brief Get a binary package field value
-## @details \fBob_get_binary_parameter\fP gets the value of a binary package
+## @details \fBob_get_binary_parameter\fP() gets the value of a binary package
 ##          field.
 ## @operand package req The name of the binary package.
 ## @operand name    req The name of the field.
@@ -229,7 +229,7 @@ ob_get_binary_parameter()
 }
 
 ## @brief Get the documentation-providing binary package
-## @details \fBob_get_doc_package\fP gets the name of the binary package that
+## @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.
@@ -243,7 +243,7 @@ ob_get_doc_package()
 }
 
 ## @brief Get the source package documentation files table
-## @details \fBob_get_doc_files\fP gets the table of source package
+## @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.
--
cgit v0.9.1