It would be
interesting if you can get the "derbydocs" javadoc build going using
multiple nested filesets, excluding the classes listed in tools/
javadoc/derbydocs_excludes.ant, and avoid the need to copy the entire
source tree to a new directory before generating the javadoc.
I'm possibly looking at this too simplistically, but I just tried
this simple change (attached) and it seemed to generate the correct javadoc
for me. In addition to tweaking the build.xml to pass the java classes
as nested filesets, rather than by making a source tree copy, I also
had to add a few more patterns to derbydocs_excludes.ant, to tell javadoc
to keep its hands off of build.xml files, properties files, etc.
Of course, I don't have a lot of experience generating Derby javadoc
so please try it and tell me whether you think it actually *does*
generate the correct javadoc.
thanks,
bryan
Index: tools/javadoc/derbydocs_exclusions.ant
===================================================================
--- tools/javadoc/derbydocs_exclusions.ant (revision 351528)
+++ tools/javadoc/derbydocs_exclusions.ant (working copy)
@@ -21,3 +21,8 @@
org/apache/derby/client/*40.java
org/apache/derby/client/am/*40.java
org/apache/derby/client/am/RowId.java
+**/build.xml
+**/*.properties
+**/*.jj
+**/*.tmpl
+**/package.html
Index: build.xml
===================================================================
--- build.xml (revision 351528)
+++ build.xml (working copy)
@@ -603,36 +603,12 @@
<delete dir="${out.javadoc.dir}/engine"/>
<mkdir dir="${out.javadoc.dir}/engine"/>
- <delete dir="${out.javadoc.dir}/sourcedir"/>
- <mkdir dir="${out.javadoc.dir}/sourcedir"/>
-
- <!-- engine files -->
- <copy todir="${out.javadoc.dir}/sourcedir">
- <fileset dir="${derby.engine.src.dir}"
- excludesfile="${javadoctools.dir}/derbydocs_exclusions.ant"/>
- </copy>
- <!-- client files -->
- <copy todir="${out.javadoc.dir}/sourcedir">
- <fileset dir="${derby.client.src.dir}"
- excludesfile="${javadoctools.dir}/derbydocs_exclusions.ant"/>
- </copy>
- <!-- drda files -->
- <copy todir="${out.javadoc.dir}/sourcedir">
- <fileset dir="${derby.drda.src.dir}"
- excludesfile="${javadoctools.dir}/derbydocs_exclusions.ant"/>
- </copy>
- <!-- tools files -->
- <copy todir="${out.javadoc.dir}/sourcedir">
- <fileset dir="${derby.tools.src.dir}"
- excludesfile="${javadoctools.dir}/derbydocs_exclusions.ant"/>
- </copy>
-
<javadoc
additionalparam="-J-mx320M"
packagenames="org.*"
access="private"
breakiterator="yes"
- sourcepath="${out.javadoc.dir}/sourcedir"
+ useexternalfile="yes"
classpath="${basedir}/classes;${java14compile.classpath};${jars.extras};${osgi}"
destdir="${out.javadoc.dir}/engine"
windowtitle="Apache Derby V${major}.${minor} Engine Documentation"
@@ -650,10 +626,17 @@
path="${basedir}/classes"/>
<taglet name="org.apache.derbyBuild.javadoc.EndFormatTaglet"
path="${basedir}/classes"/>
+ <fileset dir="${derby.engine.src.dir}"
+ excludesfile="${javadoctools.dir}/derbydocs_exclusions.ant"/>
+ <fileset dir="${derby.client.src.dir}"
+ excludesfile="${javadoctools.dir}/derbydocs_exclusions.ant"/>
+ <fileset dir="${derby.drda.src.dir}"
+ excludesfile="${javadoctools.dir}/derbydocs_exclusions.ant"/>
+ <fileset dir="${derby.tools.src.dir}"
+ excludesfile="${javadoctools.dir}/derbydocs_exclusions.ant"/>
+
</javadoc>
- <delete dir="${out.javadoc.dir}/sourcedir"/>
-
</target>
<target name="toolsdocs">
