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/metadata.sh')

diff --git a/lib/metadata.sh b/lib/metadata.sh
index c8201ae..5d35436 100644
--- a/lib/metadata.sh
+++ b/lib/metadata.sh
@@ -28,7 +28,7 @@ _ob_metadata_do()
 }
 
 ## @brief Validate a source package name
-## @details \fBob_validate_source_name\fP validates a source package name
+## @details \fBob_validate_source_name\fP() validates a source package name
 ##          against the rules of the metadata plugin selected at libopkbuild's
 ##          build time.
 ## @operand name req The source package name to validate.
@@ -45,7 +45,7 @@ ob_validate_source_name()
 }
 
 ## @brief Validate a binary package name
-## @details \fBob_validate_binary_name\fP validates a binary package name
+## @details \fBob_validate_binary_name\fP() validates a binary package name
 ##          against the rules of the metadata plugin selected at libopkbuild's
 ##          build time.
 ## @operand name req The binary package name to validate.
@@ -62,10 +62,10 @@ ob_validate_binary_name()
 }
 
 ## @brief Parse a source package version
-## @details \fBob_parse_version\fP validates and parses a source package version
-##          identifier using the metadata plugin selected at libopkbuild's build
-##          time.  Parsing is limited to extracting the entire upstream version
-##          and distribution revision.
+## @details \fBob_parse_version\fP() validates and parses a source package
+##          version identifier using the metadata plugin selected at
+##          libopkbuild's build time.  Parsing is limited to extracting the
+##          entire upstream version and distribution revision.
 ## @option -u upstreamver_var The name of the variable in which to store the
 ##                            upstream version.
 ## @option -d distrev_var     The name of the variable in which to store the
@@ -127,7 +127,7 @@ ob_parse_version()
 }
 
 ## @brief Get the running system's architecture
-## @details \fBob_get_system_arch\fP gets the architecture of the build
+## @details \fBob_get_system_arch\fP() gets the architecture of the build
 ##          (running) system using the metadata plugin selected at libopkbuild's
 ##          build time.
 ## @return Returns 0 on success or 1 if the system's architecture cannot be
@@ -142,7 +142,7 @@ ob_get_system_arch()
 }
 
 ## @brief Get the running system's platform
-## @details \fBob_get_system_arch\fP gets the platform of the build (running)
+## @details \fBob_get_system_plat\fP() gets the platform of the build (running)
 ##          system using the metadata plugin selected at libopkbuild's build
 ##          time.
 ## @return Returns 0 on success or 1 if the system's platform cannot be
@@ -310,13 +310,14 @@ ob_plat_is_concerned()
 }
 
 ## @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.
+## @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.
--
cgit v0.9.1