summaryrefslogtreecommitdiff
path: root/eclass
diff options
context:
space:
mode:
authorVlastimil Babka <caster@gentoo.org>2013-10-05 12:07:01 +0000
committerVlastimil Babka <caster@gentoo.org>2013-10-05 12:07:01 +0000
commit85ed4526fa2107b39d1d2342d23cd3551ff49e32 (patch)
tree4692c0ff6b9bd2e63f3309f36fe047393af78326 /eclass
parentold (diff)
downloadgentoo-2-85ed4526fa2107b39d1d2342d23cd3551ff49e32.tar.gz
gentoo-2-85ed4526fa2107b39d1d2342d23cd3551ff49e32.tar.bz2
gentoo-2-85ed4526fa2107b39d1d2342d23cd3551ff49e32.zip
Convert comments for eclass manpages. Almost completely based on work from 'mren <bugs@rennings.net>' in bug #210723 and ercpe from bug #476946.
Diffstat (limited to 'eclass')
-rw-r--r--eclass/ChangeLog6
-rw-r--r--eclass/ant-tasks.eclass92
2 files changed, 41 insertions, 57 deletions
diff --git a/eclass/ChangeLog b/eclass/ChangeLog
index 0f3313512e7b..ad539784cfcd 100644
--- a/eclass/ChangeLog
+++ b/eclass/ChangeLog
@@ -1,6 +1,10 @@
# ChangeLog for eclass directory
# Copyright 1999-2013 Gentoo Foundation; Distributed under the GPL v2
-# $Header: /var/cvsroot/gentoo-x86/eclass/ChangeLog,v 1.1006 2013/10/04 22:11:54 tetromino Exp $
+# $Header: /var/cvsroot/gentoo-x86/eclass/ChangeLog,v 1.1007 2013/10/05 12:07:01 caster Exp $
+
+ 05 Oct 2013; Vlastimil Babka <caster@gentoo.org> ant-tasks.eclass:
+ Convert comments for eclass manpages. Almost completely based on work from
+ 'mren <bugs@rennings.net>' in bug #210723 and ercpe from bug #476946.
04 Oct 2013; Alexandre Rostovtsev <tetromino@gentoo.org> vala.eclass:
Prepare for vala-0.22
diff --git a/eclass/ant-tasks.eclass b/eclass/ant-tasks.eclass
index 0b2d95a33f5f..f8973f15f378 100644
--- a/eclass/ant-tasks.eclass
+++ b/eclass/ant-tasks.eclass
@@ -3,7 +3,18 @@
# Copyright 1999-2013 Gentoo Foundation
# Distributed under the terms of the GNU General Public License, v2 or later
# Author Vlastimil Babka <caster@gentoo.org>
-# $Header: /var/cvsroot/gentoo-x86/eclass/ant-tasks.eclass,v 1.15 2013/08/28 21:28:33 tomwij Exp $
+# $Header: /var/cvsroot/gentoo-x86/eclass/ant-tasks.eclass,v 1.16 2013/10/05 12:07:01 caster Exp $
+
+# @ECLASS: ant-tasks.eclass
+# @MAINTAINER:
+# java@gentoo.org
+# @AUTHOR:
+# Vlastimil Babka <caster@gentoo.org>
+# @BLURB: Eclass for building dev-java/ant-* packages
+# @DESCRIPTION:
+# This eclass provides functionality and default ebuild variables for building
+# dev-java/ant-* packages easily.
+
# we set ant-core dep ourselves, restricted
JAVA_ANT_DISABLE_ANT_CORE_DEP=true
@@ -13,65 +24,39 @@ inherit versionator java-pkg-2 java-ant-2
EXPORT_FUNCTIONS src_unpack src_compile src_install
-# -----------------------------------------------------------------------------
-# @eclass-begin
-# @eclass-shortdesc Eclass for building dev-java/ant-* packages
-# @eclass-maintainer java@gentoo.org
-#
-# This eclass provides functionality and default ebuild variables for building
-# dev-java/ant-* packages easily.
-#
-# -----------------------------------------------------------------------------
-
-# -----------------------------------------------------------------------------
-# @variable-preinherit ANT_TASK_JDKVER
-# @variable-default 1.5
-#
+# @ECLASS-VARIABLE: ANT_TASK_JDKVER
+# @DESCRIPTION:
# Affects the >=virtual/jdk version set in DEPEND string. Defaults to 1.5, can
# be overriden from ebuild BEFORE inheriting this eclass.
-# -----------------------------------------------------------------------------
ANT_TASK_JDKVER=${ANT_TASK_JDKVER-1.5}
-# -----------------------------------------------------------------------------
-# @variable-preinherit ANT_TASK_JREVER
-# @variable-default 1.5
-#
+# @ECLASS-VARIABLE: ANT_TASK_JREVER
+# @DESCRIPTION:
# Affects the >=virtual/jre version set in DEPEND string. Defaults to 1.5, can
# be overriden from ebuild BEFORE inheriting this eclass.
-# -----------------------------------------------------------------------------
ANT_TASK_JREVER=${ANT_TASK_JREVER-1.5}
-# -----------------------------------------------------------------------------
-# @variable-internal ANT_TASK_NAME
-# @variable-default the rest of $PN after "ant-"
-#
-# The name of this ant task as recognized by ant's build.xml, derived from $PN.
-# -----------------------------------------------------------------------------
+# @ECLASS-VARIABLE: ANT_TASK_NAME
+# @DESCRIPTION:
+# The name of this ant task as recognized by ant's build.xml, derived from $PN
+# by removing the ant- prefix. Read-only.
ANT_TASK_NAME="${PN#ant-}"
-# -----------------------------------------------------------------------------
-# @variable-preinherit ANT_TASK_DEPNAME
-# @variable-default $ANT_TASK_NAME
-#
+# @ECLASS-VARIABLE: ANT_TASK_DEPNAME
+# @DESCRIPTION:
# Specifies JAVA_PKG_NAME (PN{-SLOT} used with java-pkg_jar-from) of the package
# that this one depends on. Defaults to the name of ant task, ebuild can
# override it before inheriting this eclass.
-# -----------------------------------------------------------------------------
ANT_TASK_DEPNAME=${ANT_TASK_DEPNAME-${ANT_TASK_NAME}}
-# -----------------------------------------------------------------------------
-# @variable-preinherit ANT_TASK_DISABLE_VM_DEPS
-# @variable-default unset
-#
+# @ECLASS-VARIABLE: ANT_TASK_DISABLE_VM_DEPS
+# @DEFAULT_UNSET
+# @DESCRIPTION:
# If set, no JDK/JRE deps are added.
-# -----------------------------------------------------------------------------
-# -----------------------------------------------------------------------------
-# @variable-internal ANT_TASK_PV
-# @variable-default Just the number in $PV without any beta/RC suffixes
-#
+# @VARIABLE: ANT_TASK_PV
+# @INTERNAL
# Version of ant-core this task is intended to register and thus load with.
-# -----------------------------------------------------------------------------
ANT_TASK_PV="${PV}"
# special care for beta/RC releases
@@ -105,9 +90,7 @@ fi
# source/workdir name
MY_P="apache-ant-${MY_PV}"
-# -----------------------------------------------------------------------------
# Default values for standard ebuild variables, can be overriden from ebuild.
-# -----------------------------------------------------------------------------
DESCRIPTION="Apache Ant's optional tasks depending on ${ANT_TASK_DEPNAME}"
HOMEPAGE="http://ant.apache.org/"
SRC_URI="${UPSTREAM_PREFIX}/${MY_P}-src.tar.bz2
@@ -133,14 +116,15 @@ RESTRICT="test"
S="${WORKDIR}/${MY_P}"
-# ------------------------------------------------------------------------------
-# @eclass-src_unpack
+# @FUNCTION: ant-tasks_src_unpack
+# @USAGE: [ base ] [ jar-dep ] [ all ]
+# @DESCRIPTION:
+# The function Is split into two parts, defaults to both of them ('all').
#
-# Is split into two parts, defaults to both of them ('all').
# base: performs the unpack, build.xml replacement and symlinks ant.jar from
# ant-core
+#
# jar-dep: symlinks the jar file(s) from dependency package
-# ------------------------------------------------------------------------------
ant-tasks_src_unpack() {
[[ -z "${1}" ]] && ant-tasks_src_unpack all
@@ -172,22 +156,18 @@ ant-tasks_src_unpack() {
}
-# ------------------------------------------------------------------------------
-# @eclass-src_compile
-#
+# @FUNCTION: ant-tasks_src_compile
+# @DESCRIPTION:
# Compiles the jar with installed ant-core.
-# ------------------------------------------------------------------------------
ant-tasks_src_compile() {
ANT_TASKS="none" eant -Dbuild.dep=${ANT_TASK_NAME} jar-dep
}
-# ------------------------------------------------------------------------------
-# @eclass-src_install
-#
+# @FUNCTION: ant-tasks_src_install
+# @DESCRIPTION:
# Installs the jar and registers its presence for the ant launcher script.
# Version param ensures it won't get loaded (thus break) when ant-core is
# updated to newer version.
-# ------------------------------------------------------------------------------
ant-tasks_src_install() {
java-pkg_dojar build/lib/${PN}.jar
java-pkg_register-ant-task --version "${ANT_TASK_PV}"