db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rhille...@apache.org
Subject svn commit: r405560 - in /db/derby/code/trunk: build.xml index.html tools/javadoc/publishedapi.ant tools/javadoc/publishedapi_jdbc3.ant tools/javadoc/publishedapi_jdbc4.ant
Date Tue, 09 May 2006 22:41:31 GMT
Author: rhillegas
Date: Tue May  9 15:41:26 2006
New Revision: 405560

URL: http://svn.apache.org/viewcvs?rev=405560&view=rev
Log:
DERBY-1079: Patch bug1079_split2.diff, This splits the public javadoc into a jdbc3-specific
and jdbc4-specific sets when built with the jdk16 variable set.

Added:
    db/derby/code/trunk/index.html   (with props)
    db/derby/code/trunk/tools/javadoc/publishedapi_jdbc3.ant   (with props)
Modified:
    db/derby/code/trunk/build.xml
    db/derby/code/trunk/tools/javadoc/publishedapi.ant
    db/derby/code/trunk/tools/javadoc/publishedapi_jdbc4.ant

Modified: db/derby/code/trunk/build.xml
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/build.xml?rev=405560&r1=405559&r2=405560&view=diff
==============================================================================
--- db/derby/code/trunk/build.xml (original)
+++ db/derby/code/trunk/build.xml Tue May  9 15:41:26 2006
@@ -543,9 +543,12 @@
 
   <!-- javadoc specific properties -->
 
+  <property name="public.api.dir" value="${out.javadoc.dir}/publishedapi"/>
   <property name="javadoc.temp.dir" value="${out.javadoc.dir}/temp"/>
   <property name="javadoc.exclusions" value="${javadoc.temp.dir}/javadoc_exclusions"/>
   <property name="javadoc.inclusions" value="${javadoc.temp.dir}/javadoc_inclusions"/>
+  <property name="javadoc.tool.jdk14" value="${java.home}/../bin/javadoc"/>
+  <property name="javadoc.tool.jdk16" value="${jdk16}/bin/javadoc"/>
 
   <target name="javadoc"
     depends="init-javadoc-tool,init,initjars,publishedapi,derbydocs,toolsdocs,grammardocs"/>
@@ -553,11 +556,11 @@
   <target name="init-javadoc-tool" depends="init-javadoc-not-jdk16,init-javadoc-jdk16"/>
 
   <target name="init-javadoc-not-jdk16" unless="jdk16">
-    <property name="javadoc.tool" value="${java.home}/../bin/javadoc"/>
+    <property name="javadoc.tool" value="${javadoc.tool.jdk14}"/>
   </target>
 
   <target name="init-javadoc-jdk16" if="jdk16">
-    <property name="javadoc.tool" value="${jdk16}/bin/javadoc"/>
+    <property name="javadoc.tool" value="${javadoc.tool.jdk16}"/>
   </target>
 
   <target name="publishedapi" depends="init-javadoc-tool,initjars">
@@ -572,21 +575,82 @@
         name="javadoc.Footer" 
         value="Built on ${javadoc.ts}, from revision ${changenumber}"/>
   
-    <delete dir="${out.javadoc.dir}/publishedapi"/>
-    <mkdir dir="${out.javadoc.dir}/publishedapi"/>
+    <delete dir="${public.api.dir}"/>
+    <mkdir dir="${public.api.dir}"/>
 
+    <antcall target="public-jdbc3-api"/>
+    <antcall target="public-jdbc4-api"/>
+
+
+  </target>
+
+  <!--
+    Build the jdbc3 public api. Called by publishedapi target.
+  -->
+  <target name="public-jdbc3-api">
+ 
+    <antcall target="publishedapi-workhorse">
+      <param name="javadocTool" value="${javadoc.tool.jdk14}"/>
+      <param name="extraApi" value="publishedapi_jdbc3.ant"/>
+    </antcall>
+
+  </target>
+
+  <!--
+    Build the jdbc4 public api. Called by publishedapi target.
+  -->
+  <target name="public-jdbc4-api" if="jdk16">
+
+    <move todir="${out.javadoc.dir}/jdbc3">
+      <fileset dir="${public.api.dir}"/>
+    </move>
+
+    <mkdir dir="${public.api.dir}"/>
+
+    <antcall target="publishedapi-workhorse">
+      <param name="javadocTool" value="${javadoc.tool.jdk16}"/>
+      <param name="extraApi" value="publishedapi_jdbc4.ant"/>
+    </antcall>
+
+    <move todir="${out.javadoc.dir}/jdbc4">
+      <fileset dir="${public.api.dir}"/>
+    </move>
+
+    <mkdir dir="${public.api.dir}"/>
+
+    <move todir="${public.api.dir}/jdbc3">
+      <fileset dir="${out.javadoc.dir}/jdbc3"/>
+    </move>
+
+    <move todir="${public.api.dir}/jdbc4">
+      <fileset dir="${out.javadoc.dir}/jdbc4"/>
+    </move>
+
+  </target>
+
+  <!--
+    This target is called twice, once to build the JDBC3 public api
+    and then a second time to build the JDBC4 api.
+
+    javadocTool  Which javadoc tool to use: jdk14 or jdk16 tool
+    extraApi     Extra files to include in the public api.
+  -->
+  <target name="publishedapi-workhorse" depends="initjars">
+ 
     <!--  Only include the files we want customers to see.  -->
     <mkdir dir="${javadoc.temp.dir}"/>
     <antcall target="include-in-javadoc">
       <param name="more_inclusions" value="publishedapi.ant"/>
     </antcall>
-    <antcall target="publishedapi-jdk16-includes"/>
+    <antcall target="include-in-javadoc">
+      <param name="more_inclusions" value="${extraApi}"/>
+    </antcall>
 
     <javadoc sourcepath="${out.javadoc.dir}/sourcedir"
-             executable="${javadoc.tool}"
+             executable="${javadocTool}"
              classpath="${compile.classpath};${osgi};${servlet24};${out.dir}"
              breakiterator="true"
-             destdir="${out.javadoc.dir}/publishedapi"
+             destdir="${public.api.dir}"
     	     Overview="${basedir}/published_api_overview.html"
              Windowtitle="Apache Derby ${major}.${minor} API Documentation"
              Doctitle="Apache Derby ${major}.${minor} API Documentation"
@@ -606,6 +670,7 @@
     <delete dir="${javadoc.temp.dir}"/>
 
   </target>
+
 
   <target name="derbydocs" depends="init-javadoc-tool,initjars">
 

Added: db/derby/code/trunk/index.html
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/index.html?rev=405560&view=auto
==============================================================================
--- db/derby/code/trunk/index.html (added)
+++ db/derby/code/trunk/index.html Tue May  9 15:41:26 2006
@@ -0,0 +1,20 @@
+<html>
+<title>Derby Public API</title>
+<body>
+<h1>Derby Public API</h1>
+
+<p>
+Derby's public API consists of two sets of javadoc:
+</p>
+
+<ul>
+<li><a href="jdbc3/index.html">JDBC2/JDBC3 Public API</a> - Consult
+this javadoc if your application runs on
+J2SE 1.3, J2SE 1.4, or J2SE 5.0. Also consult this javadoc if your
+application runs with the CDC/Foundation Profile(JSR-169).</li>
+<li><a href="jdbc4/index.html">JDBC4 Public API</a> - Consult this
+javadoc if your application runs on Java SE 6.</li>
+</ul>
+
+</body>
+</html>

Propchange: db/derby/code/trunk/index.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: db/derby/code/trunk/tools/javadoc/publishedapi.ant
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/tools/javadoc/publishedapi.ant?rev=405560&r1=405559&r2=405560&view=diff
==============================================================================
--- db/derby/code/trunk/tools/javadoc/publishedapi.ant (original)
+++ db/derby/code/trunk/tools/javadoc/publishedapi.ant Tue May  9 15:41:26 2006
@@ -1,6 +1,6 @@
 # This file contains a list of the files that constitute the public
-# API. This includes the whole public API for Derby's JDBC3
-# implementation.
+# API. This includes the classes which are common to Derby's JDBC3
+# and JDBC4 versions of the public api.
 # 
 # IMPORTANT: all names should be like package names, but with slashes
 #            instead of dots.
@@ -27,15 +27,8 @@
 # package: org.apache.derby.jdbc
 
 org/apache/derby/jdbc/ClientBaseDataSource.java
-org/apache/derby/jdbc/ClientConnectionPoolDataSource.java
-org/apache/derby/jdbc/ClientDataSource.java
 org/apache/derby/jdbc/ClientDriver.java
-org/apache/derby/jdbc/ClientXADataSource.java
-org/apache/derby/jdbc/EmbeddedConnectionPoolDataSource.java
-org/apache/derby/jdbc/EmbeddedDataSource.java
-org/apache/derby/jdbc/EmbeddedSimpleDataSource.java
 org/apache/derby/jdbc/EmbeddedDriver.java
-org/apache/derby/jdbc/EmbeddedXADataSource.java
 
 # package: org.apache.derby.tools
 

Added: db/derby/code/trunk/tools/javadoc/publishedapi_jdbc3.ant
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/tools/javadoc/publishedapi_jdbc3.ant?rev=405560&view=auto
==============================================================================
--- db/derby/code/trunk/tools/javadoc/publishedapi_jdbc3.ant (added)
+++ db/derby/code/trunk/tools/javadoc/publishedapi_jdbc3.ant Tue May  9 15:41:26 2006
@@ -0,0 +1,27 @@
+# This file contains the extra list of the files to be included
+# with Derby's public JDBC3 api but not with the public JDBC4 api.
+# This list supplements the common list found in
+# publishedapi.ant.
+# 
+# IMPORTANT: all names should be like package names, but with slashes
+#            instead of dots.
+#
+# Add new files to the appropriate package section; add new sections
+# for new packages.
+#
+# IMPORTANT: if you are adding a new package, be sure to add it to
+#            the list of packages in the publishedapi target in
+#            the toplevel build.xml file.
+#
+# Please do not add whitespace in front of class names.
+# Blank lines and comments are allowed.
+
+# package: org.apache.derby.jdbc
+
+org/apache/derby/jdbc/ClientConnectionPoolDataSource.java
+org/apache/derby/jdbc/ClientDataSource.java
+org/apache/derby/jdbc/ClientXADataSource.java
+org/apache/derby/jdbc/EmbeddedSimpleDataSource.java
+org/apache/derby/jdbc/EmbeddedConnectionPoolDataSource.java
+org/apache/derby/jdbc/EmbeddedDataSource.java
+org/apache/derby/jdbc/EmbeddedXADataSource.java

Propchange: db/derby/code/trunk/tools/javadoc/publishedapi_jdbc3.ant
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: db/derby/code/trunk/tools/javadoc/publishedapi_jdbc4.ant
URL: http://svn.apache.org/viewcvs/db/derby/code/trunk/tools/javadoc/publishedapi_jdbc4.ant?rev=405560&r1=405559&r2=405560&view=diff
==============================================================================
--- db/derby/code/trunk/tools/javadoc/publishedapi_jdbc4.ant (original)
+++ db/derby/code/trunk/tools/javadoc/publishedapi_jdbc4.ant Tue May  9 15:41:26 2006
@@ -1,5 +1,6 @@
-# This file contains the additional files that constitute the public
-# JDBC4 API. This list supplements the JDBC3 list found in
+# This file contains the extra list of the files to be included
+# with Derby's public JDBC4 api but not with the public JDBC3 api.
+# This list supplements the common list found in
 # publishedapi.ant.
 # 
 # IMPORTANT: all names should be like package names, but with slashes



Mime
View raw message