From cc369631ff8247040bb101c60a38bd227313c656 Mon Sep 17 00:00:00 2001 From: Patrick McDermott 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. --- diff --git a/lib/changelog.sh b/lib/changelog.sh index 00e8332..e7c3f7c 100644 --- a/lib/changelog.sh +++ b/lib/changelog.sh @@ -40,8 +40,8 @@ _ob_get_changelog_expect_str() } ## @brief Parse a changelog file -## @details \fBob_parse_changelog\fP parses a \fIchangelog\fP file, formatted as -## specified at +## @details \fBob_parse_changelog\fP() parses a \fIchangelog\fP file, formatted +## as specified at ## . For ## each version entry, \fBob_parse_changelog\fP calls \fIentry_cb\fP ## with the source package name, the source package version, the list diff --git a/lib/control.sh b/lib/control.sh index 7b2d57d..e43a69e 100644 --- a/lib/control.sh +++ b/lib/control.sh @@ -39,7 +39,7 @@ _ob_parse_control_error() } ## @brief Parse a control file -## @details \fBob_parse_control\fP parses a control file of field names and +## @details \fBob_parse_control\fP() parses a control file of field names and ## values formatted like RFC 822 (or RFC 2822 or RFC 5322) headers. ## For each field, \fBob_parse_control\fP calls \fIfield_cb\fP with the ## field name, the field value, and \fIuser_data\fP as arguments. If @@ -176,8 +176,8 @@ ob_parse_control() } ## @brief Set a substitution variable -## @details \fBob_set_substvar\fP sets a substitution variable for later use by -## \fBob_substvars\fP(3). +## @details \fBob_set_substvar\fP() sets a substitution variable for later use +## by \fBob_substvars\fP(3). ## @operand name req The name of the substitution variable. May only consist ## of uppercase and lowercase Latin letters, digits, and ## hyphens and must be at least one character long. @@ -211,7 +211,7 @@ ob_set_substvar() } ## @brief Substitute variables in text -## @details \fBob_substvars\fP substitutes variables previously set with +## @details \fBob_substvars\fP() substitutes variables previously set with ## \fBob_set_substvar\fP(3) in a string. The format for variable ## substitutions is \fI${var}\fP, and substitutions can be nested. ## @operand string req The string in which to substitute variables. diff --git a/lib/deps.sh b/lib/deps.sh index 629c5bb..ceb3723 100644 --- a/lib/deps.sh +++ b/lib/deps.sh @@ -182,7 +182,7 @@ ob_parse_dep() } ## @brief Reduce dependencies to a given architecture and platform -## @details \fBob_reduce_deps\fP reduces a list of dependencies to only those +## @details \fBob_reduce_deps\fP() reduces a list of dependencies to only those ## that apply to a given architecture and platform. A list is either a ## "normal" list or a "union" list. A normal list is an "AND" list ## composed of "OR" lists, which in turn are composed of simple diff --git a/lib/locale.sh b/lib/locale.sh index 3628670..4ffd0bb 100644 --- a/lib/locale.sh +++ b/lib/locale.sh @@ -23,7 +23,8 @@ _ob_text_domain= _OB_LOCALE_PATH="${LOCALEDIR}/%s/LC_MESSAGES/%s.ms" ## @brief Get the current message domain -## @details \fBob_get_text_domain\fP prints the currently loaded message domain. +## @details \fBob_get_text_domain\fP() prints the currently loaded message +## domain. ## @return Returns 0 on success. ## @stdout Prints the name of the currently loaded message domain. ## @pure yes This function has no side effects. @@ -112,8 +113,8 @@ ob_set_locale_path() } ## @brief Get a message from the current message domain -## @details \fBob_get_msg\fP prints a message, identified by a message ID, from -## the currently loaded message catalog. +## @details \fBob_get_msg\fP() prints a message, identified by a message ID, +## from the currently loaded message catalog. ## @operand msgid req The ID of the message to print ## @return Returns 0 on success. ## @stdout Prints the requested message from the current message domain. 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. diff --git a/lib/output.sh b/lib/output.sh index f4fed80..9e8834c 100644 --- a/lib/output.sh +++ b/lib/output.sh @@ -18,8 +18,7 @@ # along with opkbuild. If not, see . ## @brief Print an error message and exit -## @details \fBob_error\fP prints \fIarguments\fP according to \fIformat\fP and -## then exits the application. +## @details \fBob_error\fP() prints \fIarguments\fP according to \fIformat\fP. ## @operand format req The format string. See \fBprintf\fP(1) for the syntax ## of \fIformat\fP. ## @operand arguments opt Arguments to be printed, as referenced by @@ -39,7 +38,7 @@ ob_error() } ## @brief Print a warning message -## @details \fBob_warn\fP prints \fIarguments\fP according to \fIformat\fP. +## @details \fBob_warn\fP() prints \fIarguments\fP according to \fIformat\fP. ## @operand format req The format string. See \fBprintf\fP(1) for the syntax ## of \fIformat\fP. ## @operand arguments opt Arguments to be printed, as referenced by @@ -59,7 +58,7 @@ ob_warn() } ## @brief Print an informational message -## @details \fBob_warn\fP prints \fIarguments\fP according to \fIformat\fP. +## @details \fBob_warn\fP() prints \fIarguments\fP according to \fIformat\fP. ## @operand format req The format string. See \fBprintf\fP(1) for the syntax ## of \fIformat\fP. ## @operand arguments opt Arguments to be printed, as referenced by 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