add javadoc generation to ant build

Author: embeepea

.gitignore

@@ -1,3 +1,4 @@
 bin
 gen-src
 mugl-schema
+doc/javadoc

README

@@ -19,6 +19,9 @@ OVERVIEW
 	graph3.xml
 	    Sample MUGL files
 
+        doc
+            Documentation files.  See 'BUILDING' below for instructions on how to generate the javadocs.
+
 SETUP
 
     After cloning this project from git, you need to also clone the 'mugl-schema' project into it, as follows:
@@ -34,6 +37,9 @@ BUILDING
 
     Execute 'ant'.
 
+    To generate the javadocs, execute 'ant javadoc'.  The output will be placed in the 'doc/javadoc' directory (which
+    will be created if it does not exist.)
+
 RUNNING
 
     'ant graph2'   (runs the org.multigraph.UITest program on the file 'graph2.xml')

build.xml

@@ -32,6 +32,7 @@
   <target name="distclean">
     <delete dir="bin"/>
     <delete dir="gen-src"/>
+    <delete dir="doc/javadoc"/>
   </target>
 
   <target depends="init,xjc" name="build">
@@ -62,4 +63,15 @@
     </java>
   </target>
 
+  <target name="javadoc" depends="xjc">
+    <mkdir dir="doc/javadoc"/>
+    <javadoc packagenames="org.multigraph.*"
+             destdir="doc/javadoc"
+             windowtitle="Test API">
+      <fileset dir="src" includes="**/*.java" />  
+      <fileset dir="gen-src" includes="**/*.java" />  
+      <doctitle><![CDATA[<h1>Multigraph</h1>]]></doctitle>
+    </javadoc>
+  </target>
+
 </project>

src/org/multigraph/datatypes/datetime/DatetimeFormatter.java

@@ -173,8 +173,8 @@ public DatetimeFormatter(String formatString) {
     /**
      * Convert a value to a string.
      *
-     * @param value The value to be converted
-     * @returns The formatted String
+     * @param  value The value to be converted
+     * @return The formatted String
      */
     @Override
         public String format(DataValue value) {
@@ -199,7 +199,7 @@ public String format(DataValue value) {
      *
      * @param c The '%' code
      * @param date The date value
-     * @returns The formatted string
+     * @return The formatted string
      */
     private static String formatSingleChar(char c, Date date) {
         SingleConversionFormatter scf = charFormatters.get(c);

src/org/multigraph/datatypes/datetime/DatetimeValue.java

@@ -64,8 +64,8 @@ public java.lang.String toString() {
 
     /**
      * Comparison function.
-     * @param x Another DatetimeValue
-     * @returns -1, 0, or 1, according as this value is less, equal, or greater than x.
+     * @param  x Another DatetimeValue
+     * @return -1, 0, or 1, according as this value is less, equal, or greater than x.
      */
     @Override
         public int compareTo(DataValue x) {

src/org/multigraph/datatypes/number/NumberFormatter.java

@@ -26,8 +26,8 @@ public NumberFormatter(String formatString) {
     /**
      * Convert a value to a string.
      *
-     * @param value The value to be converted
-     * @returns The formatted String
+     * @param  value The value to be converted
+     * @return The formatted String
      */
     @Override
         public String format(DataValue value) {
@@ -46,8 +46,8 @@ public String format(DataValue value) {
     /**
      * Convert a value to a string.
      *
-     * @param value The value to be converted
-     * @returns The formatted String
+     * @param  value The value to be converted
+     * @return The formatted String
      */
     public String format(double value) {
         return String.format(mFormatString, value);