Changeset 2605

Timestamp:

07/07/08 14:28:28 (2 months ago)

Author:

jmoore

Message:

ticket:781 Further OmeroBuild cleanups

• Javadoc now at top-level since requires source
  
• Added ant dependencies to omero.ivy for omero.class
  
• Added description to <deploy/>
  

Location:

trunk

Files:

• build.xml (modified) (7 diffs)
• components/antlib/resources/global.xml (modified) (1 diff)
• components/antlib/resources/omero.ivy (modified) (1 diff)
• components/antlib/resources/omero.xml (modified) (1 diff)
• components/antlib/resources/release.xml (deleted)
• deprecated.xml (modified) (1 diff)

trunk/build.xml

@@ -50 +50 @@
     </target>
 
-    <target name="no-tests" description="Disable tests">
+    <target name="quick" description="Disable tests">
         <property name="test.skip" value="true"/>
     </target>
@@ -59 +59 @@
         <delete dir="${dist.dir}"/>
         <delete dir="${lib.dir}/cache"/>
-        <delete includeemptydirs="true">
-            <fileset dir="${lib.dir}/repository/omero" includes="**/*"/>
-        </delete>
-    </target>
-
-    <target name="build-default" description="Build all components except for C++" depends="ivy">
+        <delete includeemptydirs="true">
+            <fileset dir="${lib.dir}/repository/omero" includes="**/*"/>
+        </delete>
+    </target>
+
+    <target name="build-default" description="Build all components except for C++ (testing disabled)" depends="ivy">
         <property name="test.skip" value="true"/>
         <iterate buildpathref="blitzserver.buildpath" target="dist"/>
@@ -93 +93 @@
     <target name="build-ear" description="Build ear and copy to dist" depends="ivy">
         <iterate buildpathref="appserver.buildpath" target="dist"/>
-        <!-- WORKAROUND: creating the blitz jar to make prepare-dist work-->
+        <!-- WORKAROUND: creating the blitz jar to make prepare-dist work-->
         <iterate buildpathref="blitzserver.buildpath" target="install"/>
         <antcall target="prepare-dist" inheritRefs="true" inheritAll="true"/>
@@ -156 +156 @@
     <!-- Internal target -->
     <target name="prepare-dist" depends="ivy">
-        <mkdir dir="${dist.dir}/bin"/>
+           <mkdir dir="${dist.dir}/bin"/>
             <copy todir="${dist.dir}/etc" overwrite="true">
                 <fileset dir="${omero.home}/etc">
@@ -167 +167 @@
                     <include name="components/antlib/**"/>
                     <include name="sql/**"/>
-                    <include name="lib/tools/**"/>
                 </fileset>
             </copy>
@@ -199 +198 @@
     </target>
 
-     <target name="findbugs" description="Generates findbugs.xml and checkstyle.xml for all components" depends="ivy">
-        <iterate buildpathref="all.buildpath"   target="findbugs"/>
-        <iterate buildpathref="tools.buildpath" target="findbugs"/>
-     </target>
-
-     <target name="coverage" depends="prepare-eclipse"
+    <target name="findbugs" description="Generates findbugs.xml and checkstyle.xml for all components" depends="ivy">
+       <iterate buildpathref="all.buildpath"   target="findbugs"/>
+       <iterate buildpathref="tools.buildpath" target="findbugs"/>
+    </target>
+
+    <target name="coverage" depends="prepare-eclipse"
         description="Merge code coverage reports into single top-level report">
-        <path id="omero.classpath">
-                <fileset dir="${omero.home}/target/libs" />
-        </path>
+        <path id="omero.classpath">
+                <fileset dir="${omero.home}/target/libs" />
+        </path>
         <taskdef resource="emma_ant.properties" classpathref="omero.classpath" />
         <emma>
@@ -220 +219 @@
             </report>
         </emma>
-     </target>
-
-     <target name="setup">
+    </target>
+
+    <target name="setup">
         <ant antfile="${omero.home}/components/antlib/resources/setup.xml" target="setup"/>
-     </target>
+    </target>
+
+    <target name="javadoc" description="Generate Javadocs for all components under dist/docs/api">
+        <mkdir dir="${dist.dir}/docs/api"/>
+        <patternset id="all.java.files">
+            <!-- Includes prefixed with "**" in order to pick up
+            tools/ components -->
+            <include name="src/**/*.java"/>
+            <include name="target/generated/src/**/*.java"/>
+            <exclude name="xxx/**"/>
+        </patternset>
+
+        <javadoc
+            failonerror="true"
+            Verbose="true"
+            maxmemory="${javadoc.maxmem}"
+            destdir="dist/docs/api"
+            author="true"
+            version="true"
+            use="true"
+            breakiterator="true"
+            windowtitle="OMERO (OME Remote Objects) Server">
+
+            <classpath>
+                <fileset dir="lib">
+                    <include name="**/*.jar"/>
+                </fileset>
+            </classpath>
+
+            <fileset dir="components/common/" defaultexcludes="yes">
+                <patternset refid="all.java.files"/>
+            </fileset>
+            <fileset dir="components/server/" defaultexcludes="yes">
+                <patternset refid="all.java.files"/>
+            </fileset>
+            <fileset dir="components/romio/" defaultexcludes="yes">
+                <patternset refid="all.java.files"/>
+            </fileset>
+            <fileset dir="components/rendering/" defaultexcludes="yes">
+                <patternset refid="all.java.files"/>
+            </fileset>
+                <fileset dir="components/client/" defaultexcludes="yes">
+                <patternset refid="all.java.files"/>
+            </fileset>
+            <!-- Skipping generated files for blitz. Just too many -->
+            <fileset dir="components/blitz/src" defaultexcludes="yes" includes="**/*.java"/>
+            <fileset dir="components/tools/WebAdmin" defaultexcludes="yes">
+                <patternset refid="all.java.files"/>
+            </fileset>
+            <fileset dir="components/tools/admin" defaultexcludes="yes">
+                <patternset refid="all.java.files"/>
+            </fileset>
+            <fileset dir="components/tools/licenses" defaultexcludes="yes">
+                <patternset refid="all.java.files"/>
+            </fileset>
+            <fileset dir="components/tools/OmeroJava" defaultexcludes="yes">
+                <patternset refid="all.java.files"/>
+            </fileset>
+
+            <doctitle><![CDATA[<h1> Omero API </h1>]]></doctitle>
+            <bottom><![CDATA[
+            <p><b><i>Copyright &#169; 2007 The University of Dundee. All Rights Reserved.</i></b></p>
+            ]]></bottom>
+
+            <tag name="DEV.TODO" scope="all" description="To do:"/>
+
+            <group title="A. Core System"
+                    packages="ome.api:ome.conditions*:ome.parameters*:ome.system*"/>
+            <group title="B. Model"
+                    packages="ome.model*"/>
+            <group title="C. Client Packages"
+                    packages="ome.client*:ome.adapters*:pojos*"/>
+            <group title="D. Server Packages"
+                    packages="ome.api.local*:ome.services*:ome.logic*:ome.tools*:ome.security*:ome.io*:ome.annotations*"/>
+            <group title="E. Blitz Server"
+                    packages="ome.services.blitz*"/>
+            <group title="E. Blitz Client"
+                    packages="omero*:omeroj*"/>
+            <group title="G. Rendering Engine"
+                    packages="omeis*"/>
+            <group title="H. Utilities"
+                    packages="ome.util*:ome.testing*"/>
+            <group title="I. Deprecated"
+                    packages="ome.dynamic*:ome.rules*"/>
+
+            <link href="http://java.sun.com/j2se/1.5/docs/api/"/>
+            <link href="http://www.springframework.org/docs/api/"/>
+            <link href="http://www.hibernate.org/hib_docs/v3/api/"/>
+            <link href="http://aopalliance.sourceforge.net/doc/"/>
+            <link href="http://lucene.apache.org/java/2_2_0/api"/>
+
+        </javadoc>
+    </target>
 
 </project>

trunk/components/antlib/resources/global.xml

@@ -33 +33 @@
         file any build script will have had to define the import.dir variable-->
         <import file="${import.dir}/directories.xml"/>
-        <import file="${import.dir}/release.xml"/>
 
         <!-- Define properties :

trunk/components/antlib/resources/omero.ivy

@@ -17 +17 @@
     <dependency name="server" rev="${omero.version}" changing="true" conf="server->server"/>
     <dependency name="blitz" rev="${omero.version}" changing="true" conf="server->server;client->client"/>
+    <!-- For java omero.class -->
+    <dependency org="ant" name="ant-launcher" rev="1.6.5" conf="server->default"/>
+    <dependency org="ant" name="ant-nodeps" rev="1.6.5" conf="server->default"/>
+    <dependency org="ant" name="ant" rev="1.6.5" conf="server->default"/>
  </dependencies>
 </ivy-module>

trunk/components/antlib/resources/omero.xml

@@ -98 +98 @@
         </target>
 
-        <target name="deploy" depends="update">
+        <target name="deploy" depends="update" description="Copy *.ear to JBOSS_HOME/server/default/deploy">
                 <fail unless="env.JBOSS_HOME"/>
                 <property name="jboss.deploy.dir" value="${env.JBOSS_HOME}/server/default/deploy"/>

trunk/deprecated.xml

@@ -16 +16 @@
 
 -->
-        <target name="quick" depends="no-tests"          description="DEPRECATED: Use no-tests"/>
         <target name="fullbuild" depends="build-default" description="DEPRECATED: Use build-all"/>
         <target name="build" depends="build-default"     description="DEPRECATED: Use build-default"/>