You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ro...@apache.org on 2010/07/08 17:48:54 UTC

svn commit: r961820 - in /qpid/trunk/qpid/java: build.xml common.xml module.xml

Author: robbie
Date: Thu Jul  8 15:48:54 2010
New Revision: 961820

URL: http://svn.apache.org/viewvc?rev=961820&view=rev
Log:
QPID-2686: Update Ant doc task

Applied patch from Andrew Kennedy <an...@gmail.com>

Modified:
    qpid/trunk/qpid/java/build.xml
    qpid/trunk/qpid/java/common.xml
    qpid/trunk/qpid/java/module.xml

Modified: qpid/trunk/qpid/java/build.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/build.xml?rev=961820&r1=961819&r2=961820&view=diff
==============================================================================
--- qpid/trunk/qpid/java/build.xml (original)
+++ qpid/trunk/qpid/java/build.xml Thu Jul  8 15:48:54 2010
@@ -106,6 +106,10 @@
     <iterate target="doc"/>
   </target>
 
+  <target name="test-doc" description="generate api-doc">
+    <iterate target="test-doc"/>
+  </target>
+
   <target name="bundle" description="create OSGi bundles">
     <iterate target="bundle"/>
   </target>

Modified: qpid/trunk/qpid/java/common.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/common.xml?rev=961820&r1=961819&r2=961820&view=diff
==============================================================================
--- qpid/trunk/qpid/java/common.xml (original)
+++ qpid/trunk/qpid/java/common.xml Thu Jul  8 15:48:54 2010
@@ -33,6 +33,8 @@
   <property name="build.bin"             location="${build}/bin"/>
   <property name="build.etc"             location="${build}/etc"/>
   <property name="build.lib"             location="${build}/lib"/>
+  <property name="build.api"             location="${build}/api"/>
+  <property name="build.test.api"        location="${build}/test-api"/>
   <property name="build.results"         location="${build}/results"/>
   <property name="build.failed"          location="${build.results}/FAILED"/>
   <property name="build.report"          location="${build}/report"/>

Modified: qpid/trunk/qpid/java/module.xml
URL: http://svn.apache.org/viewvc/qpid/trunk/qpid/java/module.xml?rev=961820&r1=961819&r2=961820&view=diff
==============================================================================
--- qpid/trunk/qpid/java/module.xml (original)
+++ qpid/trunk/qpid/java/module.xml Thu Jul  8 15:48:54 2010
@@ -40,7 +40,8 @@
   <property name="module.classes"      location="${module.build}/classes"/>
   <property name="module.instrumented" location="${module.build}/classes-instrumented"/>
   <property name="module.precompiled"  location="${module.build}/src"/>
-  <property name="module.api"          location="${module.build}/api"/>
+  <property name="module.api"          location="${build.api}/${module}/"/>
+  <property name="module.test.api"     location="${build.test.api}/${module}"/>
   <property name="module.test.classes" location="${module.build}/test/classes"/>
   <property name="module.results"      location="${build.results}/${module}"/>
   <property name="module.failed"       location="${module.results}/FAILED"/>
@@ -139,6 +140,10 @@
     <pathelement location="${module.src}"/>
     <pathelement location="${module.precompiled}"/>
   </path>
+	
+  <path id="module.test.src.path">
+    <pathelement location="${module.test.src}"/>
+  </path>
 
   <condition property="module.jar"
              value="${build.plugins}/${project.name}-${module.name}-${project.version}.jar"
@@ -196,6 +201,7 @@
     <mkdir dir="${module.classes}"/>
     <mkdir dir="${module.precompiled}"/>
     <mkdir dir="${module.api}"/>
+    <mkdir dir="${module.test.api}"/>
     <mkdir dir="${module.test.classes}"/>
     <mkdir dir="${module.results}"/>
   </target>
@@ -458,9 +464,38 @@
     <srcfiles dir="${module.src}" includes="**/*.java"/>
   </uptodate>
 
+  <property name="module.doc.access" value="package"/>
   <target name="doc" depends="prepare" unless="doc.done" description="generate api-doc">
-    <javadoc destdir="${module.api}" sourcepathref="module.src.path"
-             classpathref="module.class.path" packagenames="*"/>
+    <javadoc access="${module.doc.access}" destdir="${module.api}" author="false" version="true" use="true"
+        windowtitle="${project.name} - ${module.name} - API Documentation"
+   		sourcepathref="module.src.path" classpathref="module.class.path" packagenames="*">
+      <arg value="-J-Dhttp.proxyHost=${http.proxyHost}"/>
+      <arg value="-J-Dhttp.proxyPort=${http.proxyPort}"/>
+      <bottom><![CDATA[<em><a href="http://www.apache.org/licenses/LICENSE-2.0">Licensed to the Apache Software Foundation</a></em>]]></bottom>
+      <link href="http://java.sun.com/j2se/1.5.0/docs/api/"/>
+      <link href="http://download.oracle.com/docs/cd/E17477_01/javaee/5/api/"/>
+      <link href="http://commons.apache.org/configuration/apidocs/"/>
+      <tag name="todo" scope="all" description="Todo:" />
+    </javadoc>
+  </target>
+
+  <uptodate property="test-doc.done" targetfile="${module.test.api}/index.html">
+    <srcfiles dir="${module.test.src}" includes="**/*.java"/>
+  </uptodate>
+
+  <property name="module.test.doc.access" value="public"/>
+  <target name="test-doc" depends="prepare" unless="testdoc.done" if="module.test.src.exists" description="generate test api-doc">
+    <javadoc access="${module.test.doc.access}" destdir="${module.test.api}" author="false" version="true" use="true"
+        windowtitle="${project.name} - ${module.name} - Test API Documentation"
+   		sourcepathref="module.test.src.path" classpathref="module.test.path" packagenames="*">
+      <arg value="-J-Dhttp.proxyHost=${http.proxyHost}"/>
+      <arg value="-J-Dhttp.proxyPort=${http.proxyPort}"/>
+      <bottom><![CDATA[<em><a href="http://www.apache.org/licenses/LICENSE-2.0">Licensed to the Apache Software Foundation</a></em>]]></bottom>
+      <link href="http://java.sun.com/j2se/1.5.0/docs/api/"/>
+      <link href="http://download.oracle.com/docs/cd/E17477_01/javaee/5/api/"/>
+      <link href="http://commons.apache.org/configuration/apidocs/"/>
+      <tag name="todo" scope="all" description="Todo:" />
+    </javadoc>
   </target>
   
   <target name="release-bin-prepare">



---------------------------------------------------------------------
Apache Qpid - AMQP Messaging Implementation
Project:      http://qpid.apache.org
Use/Interact: mailto:commits-subscribe@qpid.apache.org