Author: [EMAIL PROTECTED]
Date: Fri Sep 12 08:34:59 2008
New Revision: 2713

Added:
   trunk/buildlib/UmlGraph.jar   (contents, props changed)
Modified:
   trunk/build.xml

Log:
Added an optional 'javadoc.with.umlgraph' build target that generates the javadoc with UML diagrams generated with the UMLGraph library. The one prerequisite is that you must have Graphviz installed and the 'dot' executable on your PATH before running this. Also, running this on Windows XP doesn't seem to work for some reason.

It's also important to note that the UmlGraph JAR being committed is version 4.8, which is the last version that is compatible with Java 5 (all future versions require Java 6).

Modified: trunk/build.xml
==============================================================================
--- trunk/build.xml     (original)
+++ trunk/build.xml     Fri Sep 12 08:34:59 2008
@@ -656,7 +656,7 @@
        </path>

        <target name="javadoc"
- description="Generate the Javadoc documentation for the Architect API in the build directory" + description="Generate the Javadoc documentation for the Architect API in the dist directory"
                depends="compile">
                <mkdir dir="${dist.dir}/doc/api"/>
<echo message="NOTE: If the javadoc command is not accessible from your PATH variable, then this target WILL fail."/>
@@ -676,6 +676,43 @@
                </javadoc>
        </target>

+       <target name="javadoc.with.umlgraph"
+ description="Generate the Javadoc documentation for the Architect API along with UML diagrams generated using UMLGraph"
+               depends="compile">
+               <mkdir dir="${dist.dir}/doc/api"/>
+ <echo message="NOTE: If the javadoc command is not accessible from your PATH variable, then this target WILL fail."/>
+               <javadoc sourcepath="${src}" destdir="${dist.dir}/doc/api"
+                       packagenames="ca.sqlpower.*"
+                       maxmemory="100m"
+                       windowtitle="ca.sqlpower.architect.* Power*Architect"
+                       Version="true" Author="true" Use="true"
+                       Overview="html/overview.html"
+                       classpathref="test.classpath"
+                       >
+                       <doclet name="gr.spinellis.umlgraph.doclet.UmlGraphDoc"
+                 path="buildlib/UmlGraph.jar">
+               <param name="-attributes" />
+               <param name="-operations" />
+               <param name="-qualify" />
+               <param name="-types" />
+               <param name="-visibility" />
+           </doclet>
+                       <packageset dir="${src}" defaultexcludes="yes">
+                               <include name="ca/sqlpower/**" />
+                               <exclude name="regress/**"/>
+                       </packageset>
+ <bottom><![CDATA[<i>Copyright &#169; 2003-2007 SQL Power Group Inc. <a href="http://www.sqlpower.ca/";>www.sqlpower.ca</a>]]></bottom>
+               </javadoc>
+               
+               <apply executable="dot" dest="${dist.dir}/doc" parallel="false">
+                       <arg value="-Tpng"/>
+                       <arg value="-o"/>
+                       <targetfile/>
+                       <srcfile/>
+                       <fileset dir="${dist.dir}/doc" includes="*.dot"/>
+                       <mapper type="glob" from="*.dot" to="*.png"/>
+               </apply>
+       </target>

        <target name="windows_installer" depends="stage">
                <izpack 
output="${dist.dir}/Architect-Setup-Windows-${app.version}.jar"

Added: trunk/buildlib/UmlGraph.jar
==============================================================================
Binary file. No diff available.

Reply via email to