You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by fu...@apache.org on 2006/02/08 01:33:49 UTC
svn commit: r375810 - in /db/derby/code/trunk: ./
java/engine/org/apache/derby/impl/services/bytecode/
java/shared/org/apache/derby/shared/common/i18n/
java/shared/org/apache/derby/shared/common/info/ tools/javadoc/
Author: fuzzylogic
Date: Tue Feb 7 16:33:48 2006
New Revision: 375810
URL: http://svn.apache.org/viewcvs?rev=375810&view=rev
Log:
DERBY-875: Use nested filesets to improve Javadoc generation.
Original patch contributed by Bryan Pendleton <bp...@amberpoint.com>
Added:
db/derby/code/trunk/tools/javadoc/package-list
Modified:
db/derby/code/trunk/build.xml
db/derby/code/trunk/java/engine/org/apache/derby/impl/services/bytecode/CodeChunk.java
db/derby/code/trunk/java/shared/org/apache/derby/shared/common/i18n/MessageUtil.java
db/derby/code/trunk/java/shared/org/apache/derby/shared/common/info/JVMInfo.java
db/derby/code/trunk/tools/javadoc/derbydocs_exclusions.ant
Modified: db/derby/code/trunk/build.xml
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/build.xml?rev=375810&r1=375809&r2=375810&view=diff
==============================================================================
--- db/derby/code/trunk/build.xml (original)
+++ db/derby/code/trunk/build.xml Tue Feb 7 16:33:48 2006
@@ -586,37 +586,19 @@
<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>
+ <!-- Some of the link tags are lost when using nested filesets. Fool -->
+ <!-- javadoc into creating relative links by seeding it with the list -->
+ <!-- of packages that have @link tags in their package.htmls -->
+ <copy file="${javadoctools.dir}/package-list"
+ todir="${out.javadoc.dir}/engine"/>
<javadoc
additionalparam="-J-mx320M"
packagenames="org.*"
access="private"
breakiterator="yes"
- sourcepath="${out.javadoc.dir}/sourcedir"
- classpath="${basedir}/classes;${java14compile.classpath};${jars.extras};${osgi}"
+ useexternalfile="yes"
+ classpath="${out.dir};${java14compile.classpath};${jars.extras};${osgi}"
destdir="${out.javadoc.dir}/engine"
windowtitle="Apache Derby V${major}.${minor} Engine Documentation"
doctitle="Apache Derby V${major}.${minor} Engine Documentation"
@@ -633,9 +615,18 @@
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.shared.src.dir}"
+ excludesfile="${javadoctools.dir}/derbydocs_exclusions.ant"/>
+ <fileset dir="${derby.tools.src.dir}"
+ excludesfile="${javadoctools.dir}/derbydocs_exclusions.ant"/>
+ <link href="${out.javadoc.dir}/engine"/>
</javadoc>
-
- <delete dir="${out.javadoc.dir}/sourcedir"/>
</target>
Modified: db/derby/code/trunk/java/engine/org/apache/derby/impl/services/bytecode/CodeChunk.java
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/java/engine/org/apache/derby/impl/services/bytecode/CodeChunk.java?rev=375810&r1=375809&r2=375810&view=diff
==============================================================================
--- db/derby/code/trunk/java/engine/org/apache/derby/impl/services/bytecode/CodeChunk.java (original)
+++ db/derby/code/trunk/java/engine/org/apache/derby/impl/services/bytecode/CodeChunk.java Tue Feb 7 16:33:48 2006
@@ -334,7 +334,7 @@
* since 8 bytes are written.
* For a nested CodeChunk return by insertCodeSpace the delta
* corresponds to the original starting pc.
- * @see insetCodeSpace
+ * @see #insertCodeSpace
*/
private final int pcDelta;
@@ -482,7 +482,6 @@
*
* @param pc
* @param additionalBytes
- * @return
*/
CodeChunk insertCodeSpace(int pc, int additionalBytes)
{
Modified: db/derby/code/trunk/java/shared/org/apache/derby/shared/common/i18n/MessageUtil.java
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/java/shared/org/apache/derby/shared/common/i18n/MessageUtil.java?rev=375810&r1=375809&r2=375810&view=diff
==============================================================================
--- db/derby/code/trunk/java/shared/org/apache/derby/shared/common/i18n/MessageUtil.java (original)
+++ db/derby/code/trunk/java/shared/org/apache/derby/shared/common/i18n/MessageUtil.java Tue Feb 7 16:33:48 2006
@@ -128,7 +128,7 @@
* The message for the given message id, with arguments
* substituted.
*
- * @throw MissingResourceException
+ * @throws MissingResourceException
* If the message could not be found and the
* <code>composeDefault</code> parameter was set to false.
*/
Modified: db/derby/code/trunk/java/shared/org/apache/derby/shared/common/info/JVMInfo.java
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/java/shared/org/apache/derby/shared/common/info/JVMInfo.java?rev=375810&r1=375809&r2=375810&view=diff
==============================================================================
--- db/derby/code/trunk/java/shared/org/apache/derby/shared/common/info/JVMInfo.java (original)
+++ db/derby/code/trunk/java/shared/org/apache/derby/shared/common/info/JVMInfo.java Tue Feb 7 16:33:48 2006
@@ -41,7 +41,6 @@
<LI> 5 - J2SE_142 - JDK 1.4.2
<LI> 6 - J2SE_15 - JDK 1.5
</UL>
- @return The JVM's runtime environment.
*/
public static final int JDK_ID;
Modified: db/derby/code/trunk/tools/javadoc/derbydocs_exclusions.ant
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/tools/javadoc/derbydocs_exclusions.ant?rev=375810&r1=375809&r2=375810&view=diff
==============================================================================
--- db/derby/code/trunk/tools/javadoc/derbydocs_exclusions.ant (original)
+++ db/derby/code/trunk/tools/javadoc/derbydocs_exclusions.ant Tue Feb 7 16:33:48 2006
@@ -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
Added: db/derby/code/trunk/tools/javadoc/package-list
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/tools/javadoc/package-list?rev=375810&view=auto
==============================================================================
--- db/derby/code/trunk/tools/javadoc/package-list (added)
+++ db/derby/code/trunk/tools/javadoc/package-list Tue Feb 7 16:33:48 2006
@@ -0,0 +1,3 @@
+org.apache.derby.iapi.store.access.conglomerate
+org.apache.derby.impl.services.cache
+org.apache.derby.impl.store.access.btree