MONDRIAN: Generate UML diagrams into javadoc using yDoc (continued).

[git-p4: depot-paths = "//open/mondrian/": change = 8452]

build.xml

@@ -8,7 +8,7 @@
   == All Rights Reserved.
   == You must accept the terms of that agreement to use this software.
   -->
-<project name="mondrian" default="compile">
+<project name="mondrian" default="all">
   <property environment="env"/>
   <property name="project.location" location="."/>
   <property name="lib.location" location="${project.location}/lib"/>
@@ -210,8 +210,6 @@ demo/access/MondrianFoodMart.mdb"/>
   <echo>==============================================================</echo>
   </target>
 
-  <target name="all" depends="clean,compile,test"/>
-
   <target name="clean">
     <delete includeEmptyDirs="true" quiet="true">
       <fileset dir="${classes.dir}" includes="**/*.class,**/*.properties"/>
@@ -282,15 +280,18 @@ demo/access/MondrianFoodMart.mdb"/>
     <delete dir="${crtmp.dir}" quiet="true"/>
   </target>
 
+    <target name="all" depends="
+compile,
+unzip-FoodMartCreateData,
+unzip-FoodMartAccessDB,
+unzip-FoodMartDerbyDB"/>
+
   <target name="compile" depends="
 prepare,
 parser,
 generate.resources,
 def,
-compile.java,
-unzip-FoodMartCreateData,
-unzip-FoodMartAccessDB,
-unzip-FoodMartDerbyDB"/>
+compile.java"/>
 
   <target name="generate.resources">
     <taskdef name="resgen" classname="org.eigenbase.resgen.ResourceGenTask">
@@ -753,7 +754,7 @@ ${doc.dir}/api/src-html/**/*"/>
   </target>
 
   <target name="doczip"
-      depends="javadoc, xml_schema"
+      depends="javadoc-with-ydoc, xml_schema"
       description="Builds a zipfile of the documentation, which can then be
                    deployed to sf.net. See also doc/deployDoc.sh.">
     <mkdir dir="${dist.dir}" />
@@ -829,8 +830,6 @@ doc/**/*.xml"
         Windowtitle="Mondrian OLAP Server, version ${version}"
         additionalparam="-linksource"
       >
-      <!--
-        -->
       <tag name="pre" description="Pre-condition:"
            scope="constructors,methods"/>
       <tag name="post" description="Post-condition:"
@@ -847,6 +846,45 @@ doc/**/*.xml"
         todir="${javadoc.dir}/mondrian/olap"/>
   </target>
 
+  <!-- Generate javadoc with embedded UML diagrams using the yDoc doclet from
+       yWorks.com. Set ydoc.home in build.properties, then replace
+       ${ydoc.home}/resources/ydoc.license with a full license (free for open
+       source use). -->
+  <target name="javadoc-with-ydoc">
+    <mkdir dir="${javadoc.dir}" />
+    <delete quiet="true" file="${javadoc.dir}/index.html"/>
+    <property name="ps" value="${path.separator}"/>
+    <javadoc sourcepath="${java.dir}"
+        classpathref="project.test.classpath"
+        destdir="${javadoc.dir}"
+        packagenames="mondrian.*,javax.*,org.omg.*"
+        overview="${java.dir}/overview.html"
+        footer="&lt;a href=&quot;http://sourceforge.net/projects/mondrian&quot;&gt;&lt;img src=&quot;http://sourceforge.net/sflogo.php?group_id=35302&#38;type=1&quot; width=&quot;88&quot; height=&quot;31&quot; border=&quot;0&quot; alt=&quot;SourceForge.net_Logo&quot;&gt;&lt;/a&gt;"
+        author="true"
+        source="1.5"
+        access="package"
+        Windowtitle="Mondrian OLAP Server, version ${version}"
+        additionalparam="-linksource"
+      >
+      <doclet
+          name="ydoc.doclets.YStandard"
+          path="${ydoc.home}/lib/ydoc.jar${ps}${ydoc.home}/lib/class2svg.jar${ps}${ydoc.home}/resources${ps}${ydoc.home}/doc">
+        <param name="-author"/>
+        <param name="-generic"/>
+        <param name="-umlautogen"/>
+        <param name="-tag" value="y.precondition"/>
+        <param name="-tag" value="y.postcondition"/>
+        <param name="-tag" value="y.complexity"/>
+        <param name="-tag" value="param"/>
+        <param name="-tag" value="return"/>
+        <param name="-tag" value="see"/>
+        <param name="-tag" value="y.uml"/>
+      </doclet>
+    </javadoc>
+    <copy file="${java.dir}/mondrian/olap/Mondrian.xml"
+        todir="${javadoc.dir}/mondrian/olap"/>
+  </target>
+
   <target name="copy-jars">
     <copy todir="${lib.dir}">
       <fileset dir="${ant.home}/lib" includes="ant.jar,optional.jar"/>

src/main/mondrian/calc/HierarchyCalc.java

@@ -13,9 +13,9 @@
 import mondrian.olap.Hierarchy;
 
 /**
- * Expression which yields a {@link mondrian.olap.Hierarchy}.<p/>
+ * Expression which yields a {@link mondrian.olap.Hierarchy}.
  *
- * When implementing this interface, it is convenient to extend
+ * <p>When implementing this interface, it is convenient to extend
  * {@link mondrian.calc.impl.AbstractHierarchyCalc}, but it is not required.
  *
  * @author jhyde

src/main/mondrian/calc/IntegerCalc.java

@@ -12,9 +12,9 @@
 import mondrian.olap.Evaluator;
 
 /**
- * Compiled expression whose result is an <code>int</code>.<p/>
+ * Compiled expression whose result is an <code>int</code>.
  *
- * When implementing this interface, it is convenient to extend
+ * <p>When implementing this interface, it is convenient to extend
  * {@link mondrian.calc.impl.AbstractIntegerCalc}, but it is not required.
  *
  * @author jhyde

src/main/mondrian/calc/LevelCalc.java

@@ -13,9 +13,9 @@
 import mondrian.olap.Level;
 
 /**
- * Expression which yields a {@link mondrian.olap.Level}.<p/>
+ * Expression which yields a {@link mondrian.olap.Level}.
  *
- * When implementing this interface, it is convenient to extend
+ * <p>When implementing this interface, it is convenient to extend
  * {@link mondrian.calc.impl.AbstractLevelCalc}, but it is not required.
  *
  * @author jhyde

src/main/mondrian/calc/MemberCalc.java

@@ -13,9 +13,9 @@
 import mondrian.olap.Member;
 
 /**
- * Expression which yields a {@link Member}.<p/>
+ * Expression which yields a {@link Member}.
  *
- * When implementing this interface, it is convenient to extend
+ * <p>When implementing this interface, it is convenient to extend
  * {@link mondrian.calc.impl.AbstractMemberCalc}, but it is not required.
 
  * @author jhyde

src/main/mondrian/calc/StringCalc.java

@@ -12,9 +12,9 @@
 import mondrian.olap.Evaluator;
 
 /**
- * Compiled expression whose result is a {@link String}.<p/>
+ * Compiled expression whose result is a {@link String}.
  *
- * When implementing this interface, it is convenient to extend
+ * <p>When implementing this interface, it is convenient to extend
  * {@link mondrian.calc.impl.AbstractStringCalc}, but it is not required.
  *
  * @author jhyde

src/main/mondrian/calc/TupleCalc.java

@@ -14,10 +14,11 @@
 
 /**
  * Expression which yields a tuple.
- * The tuple is represented as an array of {@link Member} objects,
- * <code>null</code> to represent the null tuple.<p/>
  *
- * When implementing this interface, it is convenient to extend
+ * <p>The tuple is represented as an array of {@link Member} objects,
+ * <code>null</code> to represent the null tuple.
+ *
+ * <p>When implementing this interface, it is convenient to extend
  * {@link mondrian.calc.impl.AbstractTupleCalc}, but it is not required.
  *
  * @author jhyde

src/main/mondrian/calc/VoidCalc.java

@@ -13,7 +13,8 @@
 
 /**
  * Expression which has a void result.
- * Since it doesn't return anything, any useful implementation of this
+ *
+ * <p>Since it doesn't return anything, any useful implementation of this
  * class will do its work by causing side-effects.
  *
  * @author jhyde