db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jan Hlavatý <hla...@code.cz>
Subject [PATCH] Various fixes to javadoc generation
Date Fri, 27 Aug 2004 01:16:39 GMT
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I've been playing around with javadoc building a little more.
Attached patch contains results:

- - made some dependency fixes so that javadoc can be built right from
clean state

- - added -source 1.4 to javadoc invocations to prevent JDK 1.5 javadoc
from complaining about enums. These enums must go though!

- - replaced nasty javadoc hack in "javadocsubpackages" target with
regular javadoc tag that does exactly the same thing (original author
probably didn't fugure out how to pass JVM parameter to increase memory
~ to javadoc tag)

I can generate whole documentation now, including grammars.
I even found a bug in JDK 1.5 javadoc during the process, which i
reported promptly ;-)

Javadoc tags are (as usual) a real mess, I'd like to fix them, but
without having commit access it would be really painful ;-)

I also looked at future JDK 1.5 compatibility, there are a lot of enum
identifiers that have to be changed ;)

Don't forget to apply my prevoius javadoctools.dir fix ;-)

Jan

- ----------
Index: build.xml
===================================================================
- --- build.xml	(revision 37084)
+++ build.xml	(working copy)
@@ -350,7 +350,7 @@
~ <!--                           Javadoc targets
~  -->
~ <!--
=================================================================== -->

- -  <target name="javadoc"
depends="publishedapi,derbydocs,toolsdocs,grammardocs"/>
+  <target name="javadoc"
depends="buildsource,publishedapi,derbydocs,toolsdocs,grammardocs"/>

~   <target name="publishedapi">

@@ -442,37 +442,25 @@

~   </target>

- -  <target name="javadocsubpackages">
- -    <java classname="com.sun.tools.javadoc.Main" fork="yes">
- -      <classpath path="${java.home}/../lib/tools.jar;${out.dir}"/>
- -      <jvmarg value="-mx320M"/>
- -      <arg value="-subpackages"/>
- -      <arg value="org"/>
- -      <arg value="-private"/>
- -      <arg value="-breakiterator"/>
- -      <arg value="-sourcepath"/>
- -      <arg value="${javadoc.sourcepath}"/>
- -      <arg value="-classpath"/>
- -      <arg value="${javadoc.classpath}"/>
- -      <arg value="-d"/>
- -      <arg value="${javadoc.destdir}"/>
- -      <arg value="-windowtitle"/>
- -      <arg value="${javadoc.windowtitle}"/>
- -      <arg value="-doctitle"/>
- -      <arg value="${javadoc.doctitle}"/>
- -      <arg value="-bottom"/>
- -      <arg value="${javadoc.bottom}"/>
- -      <arg value="-taglet"/>
- -      <arg value="org.apache.derbyBuild.javadoc.FormatIdTaglet"/>
- -      <arg value="-taglet"/>
- -      <arg value="org.apache.derbyBuild.javadoc.PurposeTaglet"/>
- -      <arg value="-taglet"/>
- -      <arg value="org.apache.derbyBuild.javadoc.UpgradeTaglet"/>
- -      <arg value="-taglet"/>
- -      <arg value="org.apache.derbyBuild.javadoc.DiskLayoutTaglet"/>
- -      <arg value="-taglet"/>
- -      <arg value="org.apache.derbyBuild.javadoc.EndFormatTaglet"/>
- -    </java>
+  <target name="javadocsubpackages" depends="build">
+    <javadoc
+        additionalparam="-J-mx320M"
+        packagenames="org.*"
+        access="private"
+        breakiterator="yes"
+        sourcepath="${javadoc.sourcepath}"
+        classpath="${javadoc.classpath}"
+        destdir="${javadoc.destdir}"
+        windowtitle="${javadoc.windowtitle}"
+        doctitle="${javadoc.doctitle}"
+        bottom="${javadoc.bottom}"
+        source="1.4" >
+        <taglet name="org.apache.derbyBuild.javadoc.FormatIdTaglet"
path="${basedir}/classes"/>
+        <taglet name="org.apache.derbyBuild.javadoc.PurposeTaglet"
path="${basedir}/classes"/>
+        <taglet name="org.apache.derbyBuild.javadoc.UpgradeTaglet"
path="${basedir}/classes"/>
+        <taglet name="org.apache.derbyBuild.javadoc.DiskLayoutTaglet"
path="${basedir}/classes"/>
+        <taglet name="org.apache.derbyBuild.javadoc.EndFormatTaglet"
path="${basedir}/classes"/>
+    </javadoc>
~   </target>

~   <target name="cleandocs">
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.4 (MingW32)
Comment: Using GnuPG with Thunderbird - http://enigmail.mozdev.org

iQEVAwUBQS6Ld3FDePgyse5HAQLyZwf9HEkwqfqfXlr+8VF3+Jt0YrNzs25nS9H7
CHrFXlC1zbnw8vi5HhV/XJS9aiL9KbiG98xEEVE4bQpo55PcQwGkTUA0w9dPQfAt
v01gbuoQC2CM7xXS8oNIkBzYGodVDh/rA24XQ4MgQmHJzIxWAA7dxEZHrO9UqSLz
d4EG/mso8Rj4ThxyD0IpTNkKKK9JeuJwWFRTg7viKn1fiYvblgRWH7en+hXAFV9d
4M00WPB2qxV3HbuYWiptEmV+lkc2vX8dXPZ61Y4Cv3KVzm8389OyCPWLEC5soX+I
MWm18WVPIlE9THhsX7kDY8kvoRWUmmE2m+qLPYK7YsJv/OM0ulYRlA==
=IoH2
-----END PGP SIGNATURE-----

Mime
View raw message