postgres{,-multi}.eclass: More Documentation Fixes
authorAaron W. Swenson <titanofold@gentoo.org>
Tue, 11 Jul 2017 14:29:45 +0000 (10:29 -0400)
committerAaron W. Swenson <titanofold@gentoo.org>
Tue, 11 Jul 2017 14:57:43 +0000 (10:57 -0400)
Fix a few keyword typos and adhere to the doc standard.

Bugs: 624502

eclass/postgres-multi.eclass
eclass/postgres.eclass

index 12575ff047af41c0c05af05067e1da92287fefc2..5d40a0e7c8be290522023392467d2a9939d5b67a 100644 (file)
@@ -39,7 +39,7 @@ fi
 # POSTGRES_COMPAT.
 export _POSTGRES_INTERSECT_SLOTS=( )
 
-# @FUNCTION _postgres-multi_multibuild_wrapper
+# @FUNCTION: _postgres-multi_multibuild_wrapper
 # @INTERNAL
 # @USAGE: _postgres-multi_multibuild_wrapper <command> [<arg> ...]
 # @DESCRIPTION:
@@ -98,7 +98,6 @@ postgres-multi_forbest() {
 }
 
 # @FUNCTION: postgres-multi_pkg_setup
-# @REQUIRED
 # @USAGE: postgres-multi_pkg_setup
 # @DESCRIPTION:
 # Initialize internal environment variable(s). This is required if
@@ -119,7 +118,6 @@ postgres-multi_pkg_setup() {
 }
 
 # @FUNCTION: postgres-multi_src_prepare
-# @REQUIRED
 # @USAGE: postgres-multi_src_prepare
 # @DESCRIPTION:
 # Calls eapply_user then copies ${S} into a build directory for each
index ab7b34102e2bc577c92da73803b0f1a795ed95b3..13483a9ec12f22091b64a41c9e46cf86115b1236 100644 (file)
@@ -23,12 +23,14 @@ esac
 
 
 # @ECLASS-VARIABLE: POSTGRES_COMPAT
+# @DEFAULT_UNSET
 # @DESCRIPTION:
 # A Bash array containing a list of compatible PostgreSQL slots as
 # defined by the developer. If declared, must be declared before
 # inheriting this eclass. Example: POSTGRES_COMPAT=( 9.4 9.{5,6} )
 
 # @ECLASS-VARIABLE: POSTGRES_USEDEP
+# @DEFAULT_UNSET
 # @DESCRIPTION:
 # Add the 2-Style and/or 4-Style use dependencies without brackets to be used
 # for POSTGRES_DEP. If declared, must be done before inheriting this eclass.
@@ -114,7 +116,6 @@ postgres_new_user() {
 }
 
 # @FUNCTION: postgres_pkg_setup
-# @REQUIRED
 # @USAGE: postgres_pkg_setup
 # @DESCRIPTION:
 # Initialize environment variable(s) according to the best