[gentoo-dev] [PATCH v2 2/3] gnuconfig.eclass: provide basic @ECLASS block, docs

[Sam James]

Signed-off-by: Sam James <sam@g.o>
---
 eclass/gnuconfig.eclass | 33 +++++++++++++++++++++++----------
 1 file changed, 23 insertions(+), 10 deletions(-)

diff --git a/eclass/gnuconfig.eclass b/eclass/gnuconfig.eclass
index 3433837787c..f679441445f 100644
--- a/eclass/gnuconfig.eclass
+++ b/eclass/gnuconfig.eclass
@@ -1,25 +1,32 @@
-# Copyright 1999-2020 Gentoo Authors
+# Copyright 1999-2021 Gentoo Authors
 # Distributed under the terms of the GNU General Public License v2
-#
-# Author: Will Woods <wwoods@g.o>
-#
+
+# @ECLASS: gnuconfig.eclass
+# @MAINTAINER:
+# maintainer-needed@g.o
+# @AUTHOR:
+# Will Woods <wwoods@g.o>
+# @BLURB: Eclass to make PCF font generator from BDF uniform and optimal
+# @DESCRIPTION:
 # This eclass is used to automatically update files that typically come with
 # automake to the newest version available on the system. The most common use
 # of this is to update config.guess and config.sub when configure dies from
 # misguessing your canonical system name (CHOST). It can also be used to update
 # other files that come with automake, e.g. depcomp, mkinstalldirs, etc.
 #
-# usage: gnuconfig_update [file1 file2 ...]
+
+DEPEND="sys-devel/gnuconfig"
+
+# @FUNCTION: gnuconfig_update
+# @USAGE: [file1 file2 ...]
+# @DESCRIPTION:
 # if called without arguments, config.guess and config.sub will be updated.
 # All files in the source tree ($S) with the given name(s) will be replaced
 # with the newest available versions chosen from the list of locations in
 # gnuconfig_findnewest(), below.
 #
 # gnuconfig_update should generally be called from src_unpack()
-
-
-DEPEND="sys-devel/gnuconfig"
-
+#
 # Wrapper function for gnuconfig_do_update. If no arguments are given, update
 # config.sub and config.guess (old default behavior), otherwise update the
 # named files.
@@ -42,6 +49,9 @@ gnuconfig_update() {
 	return $?
 }
 
+# @FUNCTION: gnuconfig_do_update
+# @INTERNAL
+# @DESCRIPTION:
 # Copy the newest available version of specified files over any old ones in the
 # source dir. This function shouldn't be called directly - use gnuconfig_update
 #
@@ -75,7 +85,10 @@ gnuconfig_do_update() {
 	return 0
 }
 
-# this searches the standard locations for the newest config.{sub|guess}, and
+# @FUNCTION: gnuconfig_findnewest
+# @INTERNAL
+# @DESCRIPTION:
+# This searches the standard locations for the newest config.{sub|guess}, and
 # returns the directory where they can be found.
 gnuconfig_findnewest() {
 	local locations=(
-- 
2.31.1