summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Bauman <bman@gentoo.org>2020-12-15 14:32:45 -0500
committerAaron Bauman <bman@gentoo.org>2020-12-15 15:19:55 -0500
commitb2feff70180326e33626cc411e3357e2957ab2b8 (patch)
tree2bae5228fa7b5b2df722db9e2ef2c0debdeaad40
parenteclass/check-reqs: fix eclass documentation (diff)
downloadgentoo-b2feff70180326e33626cc411e3357e2957ab2b8.tar.gz
gentoo-b2feff70180326e33626cc411e3357e2957ab2b8.tar.bz2
gentoo-b2feff70180326e33626cc411e3357e2957ab2b8.zip
eclass/font-ebdftopcf: fix documentation
Signed-off-by: Aaron Bauman <bman@gentoo.org>
-rw-r--r--eclass/font-ebdftopcf.eclass27
1 files changed, 15 insertions, 12 deletions
diff --git a/eclass/font-ebdftopcf.eclass b/eclass/font-ebdftopcf.eclass
index c36cd14256fa..9e00eec467f2 100644
--- a/eclass/font-ebdftopcf.eclass
+++ b/eclass/font-ebdftopcf.eclass
@@ -1,12 +1,15 @@
-# Copyright 1999-2011 Gentoo Foundation
+# Copyright 1999-2020 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
-# Author: Robin H. Johnson <robbat2@gentoo.org>
-
-# font-ebdftopcf.eclass
-# Eclass to make PCF font generator from BDF uniform and optimal
+# @ECLASS: font-ebdftopcf.eclass
+# @MAINTAINER:
+# Robin H. Johnson <robbat2@gentoo.org>
+# @AUTHOR:
+# Robin H. Johnson <robbat2@gentoo.org>
+# @BLURB: A simple eclass to convert BDF to PCF
+# @DESCRIPTION:
+# Make PCF font generator from BDF uniform and optimal
# The manpage for this eclass is in media-gfx/ebdftopcf.
-
# inherit this eclass after font.eclass
# if USE="-X", this eclass is basically a no-op, since bdftopcf requires Xorg.
@@ -16,9 +19,9 @@ IUSE="X"
DEPEND="X? ( media-gfx/ebdftopcf )"
RDEPEND=""
-#
-# Public functions
-#
+# @FUNCTION: ebdftopcf
+# @DESCRIPTION:
+# Convert BDF files to PCF
ebdftopcf() {
local bdffiles
bdffiles="$@"
@@ -29,9 +32,9 @@ ebdftopcf() {
|| die "Failed to build PCF files"
}
-#
-# Public inheritable functions
-#
+# @FUNCTION: font-ebdftopcf_src_compile
+# @DESCRIPTION:
+# Convert fonts from BDF to PCF
font-ebdftopcf_src_compile() {
use X && FONT_SUFFIX="pcf.gz"
use X || FONT_SUFFIX="bdf"