java-{mvn-src,osgi,pkg-simple}.eclass: Rewrite documentation to make it compliant with the new style. Fixes bug 476946.

Signed-off-by: Patrice Clement <monsieurp@gentoo.org>

1 files changed, 22 insertions, 33 deletions

diff --git a/eclass/java-mvn-src.eclass b/eclass/java-mvn-src.eclass
index c34034eb00d7..a7f8e5bc2fa5 100644
--- a/eclass/java-mvn-src.eclass
+++ b/eclass/java-mvn-src.eclass
@@ -2,12 +2,13 @@
 # Distributed under the terms of the GNU General Public License v2
 # $Id$
 
-inherit java-pkg-simple
-
-# -----------------------------------------------------------------------------
-# @eclass-begin
-# @eclass-summary Eclass for Java packages from bare sources exported by Maven
-#
+# @ECLASS: java-mvn-src.eclass
+# @MAINTAINER:
+# java@gentoo.org
+# @AUTHOR:
+# Java maintainers (java@gentoo.org)
+# @BLURB: Eclass for Java packages from bare sources exported by Maven
+# @DESCRIPTION:
 # This class is intended to build pure Java packages from the sources exported
 # from the source:jar goal of Maven 2. These archives contain bare Java source
 # files, with no build instructions or additional resource files. They are
@@ -16,38 +17,30 @@ inherit java-pkg-simple
 # are often released together with binary packages, whereas the full build
 # environment might be contained in some revision control system or not
 # available at all.
-# -----------------------------------------------------------------------------
-
-# -----------------------------------------------------------------------------
-# @variable-external GROUP_ID
-# @variable-default ${PN}
-#
-# The groupId of the artifact, in dotted notation.
-# -----------------------------------------------------------------------------
+
+inherit java-pkg-simple
+
+# @ECLASS-VARIABLE: GROUP_ID
+# @DESCRIPTION:
+# The groupId of the artifact, in dotted notation. Default value is ${PN}.
 : ${GROUP_ID:=${PN}}
 
-# -----------------------------------------------------------------------------
-# @variable-external ARTIFACT_ID
-# @variable-default ${PN}
-#
-# The artifactId of the artifact.
-# -----------------------------------------------------------------------------
+# @ECLASS-VARIABLE: ARTIFACT_ID
+# The artifactId of the artifact. Default value is ${PN}.
+
 : ${ARTIFACT_ID:=${PN}}
 
-# -----------------------------------------------------------------------------
-# @variable-external MAVEN2_REPOSITORIES
-# @variable-default http://repo2.maven.org/maven2 http://download.java.net/maven/2
-#
+# @ECLASS-VARIABLE: MAVEN2_REPOSITORIES
+# @DESCRIPTION:
 # The repositories to search for the artifacts. Must follow Maven2 layout.
-# -----------------------------------------------------------------------------
+# Default value is the following string:
+# "http://repo2.maven.org/maven2 http://download.java.net/maven/2"
 : ${MAVEN2_REPOSITORIES:="http://repo2.maven.org/maven2 http://download.java.net/maven/2"}
 
-# -----------------------------------------------------------------------------
-# @variable-internal RELATIVE_SRC_URI
-#
+# @ECLASS-VARIABLE: RELATIVE_SRC_URI
+# @DESCRIPTION:
 # The path of the source artifact relative to the root of the repository.
 # Will be set by the eclass to follow Maven 2 repository layout.
-# -----------------------------------------------------------------------------
 RELATIVE_SRC_URI=${GROUP_ID//./\/}/${ARTIFACT_ID}/${PV}/${ARTIFACT_ID}-${PV}-sources.jar
 
 # Look for source jar in all listed repositories
@@ -55,7 +48,3 @@ for repo in ${MAVEN2_REPOSITORIES}; do
 	SRC_URI="${SRC_URI} ${repo}/${RELATIVE_SRC_URI}"
 done
 unset repo
-
-# ------------------------------------------------------------------------------
-# @eclass-end
-# ------------------------------------------------------------------------------