From 6ee8a3a8dd18548d181d9f4264131934bda02c59 Mon Sep 17 00:00:00 2001
From: David Roazen <droazen@broadinstitute.org>
Date: Thu, 11 Aug 2011 19:19:25 -0400
Subject: [PATCH] Fixing the javadoc/scaladoc targets in build.xml

Usable targets are now:

ant javadoc           (public-only)
ant javadoc.private   (public + private)
ant scaladoc          (public-only)
ant scaladoc.private  (public + private)

As documented in the comments, you need to set the ANT_OPTS environment
variable to -Xmx1G before using the scaladoc targets.

Will modify bamboo to auto-generate these and post them to the web after
successful builds.
---
 build.xml | 77 +++++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 55 insertions(+), 22 deletions(-)

diff --git a/build.xml b/build.xml
index dbda3c719..85955d774 100644
--- a/build.xml
+++ b/build.xml
@@ -43,6 +43,9 @@
     <property name="scala.classes" value="${build.dir}/scala/classes" />
 
     <property name="queue-extensions.source.dir" value="${build.dir}/queue-extensions/src" />
+
+    <property name="javadoc.dir" value="javadoc" />
+    <property name="scaladoc.dir" value="scaladoc" />
     
     <!-- Contracts for Java -->
     <!-- To disable, run with -Duse.contracts=false -->
@@ -86,7 +89,6 @@
         <patternset refid="all.java.source.pattern" />
     </fileset>
 
-
     <fileset id="external.source.files" dir="${external.dir}" erroronmissingdir="false">
         <include name="**/*.java" />
     </fileset>
@@ -168,6 +170,12 @@
         <property name="scala.target" value="core"/>
     </target>
 
+    <target name="init.buildpublic">
+        <!-- Set the properties needed to build public only -->
+        <property name="gatk.target" value="core"/>
+        <property name="scala.target" value="core"/>
+    </target>
+
     <target name="git.describe">
       <exec executable="git" outputproperty="git.describe.output" resultproperty="git.describe.exit.value" failonerror="false">
         <arg line="describe" />
@@ -909,34 +917,59 @@
         <run-failed-test xmlfailedtestfile="${report}/*PipelineTest/testng-failed.xml" />
     </target>
 
-    <!-- ***************************************************************************** -->
+    <!-- ******************************************************************************** -->
+    <!-- Javadoc                                                                          -->
+    <!-- ******************************************************************************** -->
 
     <target name="clean.javadoc">
-        <delete dir="javadoc"/>
-        <delete dir="scaladoc"/>
+        <delete dir="${javadoc.dir}" />
     </target>
 
-    <target name="javadoc" depends="init.buildall,resolve,queue-extensions.generate,init.scala.compile" description="generates javadoc">
-        <mkdir dir="javadoc"/>
-        <javadoc destdir="javadoc"
-                 classpathref="external.dependencies">
-            <sourcepath path="${java.public.source.dir}"/>
-            <sourcepath path="${external.dir}"/>
+    <target name="init.javadoc">
+        <mkdir dir="${javadoc.dir}" />
+    </target>
+
+    <target name="javadoc" depends="init.buildpublic,generate.javadoc" description="Generates public javadoc" />
+
+    <target name="javadoc.private" depends="init.buildall,generate.javadoc" description="Generates public and private javadoc" />
+
+    <target name="generate.javadoc" depends="init.javadoc,resolve">
+        <javadoc destdir="${javadoc.dir}" classpathref="external.dependencies">
+            <fileset refid="java.source.files" />
+            <sourcepath path="${external.dir}" />
         </javadoc>
-        <javadoc destdir="javadoc"
-                 classpathref="external.dependencies">
-            <sourcepath path="${java.private.source.dir}"/>
-            <exclude name="**" unless="include.private" />
-        </javadoc>        
-        <mkdir dir="scaladoc"/>
-        <scaladoc srcdir="" destdir="scaladoc" classpathref="scala.dependencies" deprecation="yes" unchecked="yes">
-            <src path="${scala.public.source.dir}"/>
-            <src path="${scala.private.source.dir}"/>
-            <src path="${queue-extensions.source.dir}"/>
-            <include name="**/*.scala"/>
+    </target>
+
+    <!-- ******************************************************************************** -->
+    <!-- Scaladoc                                                                         -->
+    <!-- ******************************************************************************** -->
+
+    <target name="clean.scaladoc">
+        <delete dir="${scaladoc.dir}" />
+    </target>
+
+    <target name="init.scaladoc">
+        <mkdir dir="${scaladoc.dir}" />
+    </target>
+
+    <!-- NOTE: the scaladoc targets require that the environment variable ANT_OPTS has been set to "-Xmx1G" -->
+
+    <target name="scaladoc" depends="init.buildpublic,generate.scaladoc" description="Generates public scaladoc -- set ANT_OPTS to -Xmx1G" />
+
+    <target name="scaladoc.private" depends="init.buildall,generate.scaladoc" description="Generates public and private scaladoc -- set ANT_OPTS to -Xmx1G" />
+
+    <target name="generate.scaladoc" depends="resolve,queue-extensions.generate,init.scala.compile,scala.compile,init.scaladoc">
+        <scaladoc srcdir="${basedir}" destdir="${scaladoc.dir}" classpathref="scala.dependencies" deprecation="yes" unchecked="yes">
+            <include name="${scala.public.source.dir}/**/*.scala" />
+            <include name="${queue-extensions.source.dir}/**/*.scala" />
+            <include name="${scala.private.source.dir}/**/*.scala" if="include.private" />
         </scaladoc>
     </target>
 
+    <!-- ******************************************************************************** -->
+    <!-- Release-related tasks                                                            -->
+    <!-- ******************************************************************************** -->
+
     <!-- Unzip all classes from their current locations and assemble them in a staging directory -->
     <target name="stage" description="stage files for distribution">
         <mkdir dir="staging"/>
@@ -1026,7 +1059,7 @@
        </findbugs>
     </target>
 
-    <target name="clean" description="clean up" depends="clean.javadoc,clean.gatkdocs">
+    <target name="clean" description="clean up" depends="clean.javadoc,clean.scaladoc,clean.gatkdocs">
         <delete dir="out"/>
         <delete dir="${build.dir}"/>
         <delete dir="${lib.dir}"/>