Add build target for asdocs
[potlatch2.git] / build.xml
1 <project name="Potlatch2 ├╝ber compile system" default="debug">
2
3   <!-- load properties from the environment -->
4   <property environment="env" />
5
6   <!-- load previously defined configuration properties file -->
7   <property file="build.properties" />
8
9   <!-- flexTasks comes with flex, but apparently it's good practice to put in the libs folder -->
10   <taskdef resource="flexTasks.tasks" classpath="${basedir}/lib/flexTasks.jar"/>
11
12   <!-- if you are running git-svn, you need to run "git tag -a 0.4 0ac0de" where 0ac0de corresponds to the commitid of
13       potlatch2 v0.4 . You need to do this for each point release while we're still in SVN.
14       If you don't, then expect "git describe" to fail miserably.
15       Produces a build number of the form 0.4-1-g9692243 which means 1 commit later than 0.4, latest commit was 9692243 -->
16   <available file=".git" type="dir" property="git.present"/>
17   <target name="git-buildnumber" description="Store output from git-describe in ${buildnumber}" if="git.present">
18     <exec outputproperty="build_number" executable="git" dir="${basedir}">
19       <arg value="describe" />
20     </exec>
21   </target>
22
23   <!-- if you are running svn ("I pity the fool", etc) then svnversion will give the svn revision number, and the
24        build number will be of the form 24041 -->
25   <available file=".svn" type="dir" property="svn.present"/>
26   <target name="svn-buildnumber" description="Store output from svnversion in ${buildnumber}" if="svn.present">
27     <exec outputproperty="build_number" executable="svnversion" dir="${basedir}" />
28   </target>
29
30   <!-- delete and create the DEPLOY dir again -->
31   <target name="init" depends="git-buildnumber,svn-buildnumber">
32     <echo>Build Number ${build_number}</echo>
33     <copy file="version.as.template" tofile="version.as" overwrite="true" />
34     <replace file="version.as" token="@@@buildnumber@@@" value="${build_number}" />
35   </target>
36
37   <!-- Build and output potlatch2.swf in debug mode -->
38   <target name="debug" depends="init">
39     <mxmlc file="potlatch2.mxml">
40       <load-config filename="${FLEX_HOME}/frameworks/flex-config.xml"/>
41       <load-config filename="debug-config.xml"/>
42       <source-path path-element="${FLEX_HOME}/frameworks"/>
43       <compiler.debug>true</compiler.debug>
44     </mxmlc>
45   </target>
46
47   <!-- Build and output potlatch2.swf in release mode -->
48   <target name="release" depends="init">
49     <mxmlc file="potlatch2.mxml">
50       <load-config filename="${FLEX_HOME}/frameworks/flex-config.xml"/>
51       <source-path path-element="${FLEX_HOME}/frameworks"/>
52       <compiler.debug>false</compiler.debug>
53     </mxmlc>
54   </target>
55
56   <target name="halcyon">
57     <mxmlc file="halcyon_viewer.as" />
58   </target>
59
60   <!-- note that there's an asdoc target in Flex 4, if/when we move to that -->
61   <target name="docs" depends="manifests">
62     <exec executable="${ASDOC}" failonerror="true">
63       <arg line="-source-path ."/>
64       <arg line="-doc-sources net/systemeD/"/>
65       <arg line="-external-library-path=lib/"/>
66       <arg line="-exclude-classes ${org_classes} ${it_classes} ${hxasm_classes}"/>
67       <arg line="-output resources/docs/"/>
68       <arg line="-window-title 'Halcyon and Potlatch2 Developer documentation'" />
69       <arg line="-main-title 'Halcyon and Poltatch2 Developer documentation'" />
70       <arg line="-footer 'Found an error? Help us fix it. http://wiki.openstreetmap.org/wiki/Potlatch2'"/>
71       <arg line="-package net.systemeD.halcyon 'The AS3 rendering library'" />
72       <arg line="-package net.systemeD.potlatch2 'The OpenStreetMap editor'" />
73       <arg line="-left-frameset-width 300" />
74     </exec>
75   </target>
76
77   <target name="manifests">
78         <!-- Adapted from http://dreamingwell.com/articles/archives/2009/12/excluding-direc.php -->
79         <!-- Generating documentation for a class generates all the dependant documentation too. We
80              don't want to do this for certain projects like org.vanrijkom etc (.swc files are
81              automatically ignored). Unfortunately asdoc only has options for excluding particular
82              classes, and there's lots of them - so this stuff autogenerates the class lists that
83              we want to ignore. -->
84
85         <!-- Get the list of all files in the org directory -->
86         <fileset id="org_sources" dir="${basedir}/org/" />
87         <!-- convert the names of excluded classes to packages with class names -->
88         <pathconvert property="org_classes" pathsep=" " refid="org_sources">
89                 <chainedmapper>
90                         <globmapper from="${basedir}/*" to="*"/>
91                         <mapper type="package" from="*.as" to="*"/>
92                 </chainedmapper>
93         </pathconvert>
94
95         <fileset id="it_sources" dir="${basedir}/it/" />
96         <!-- convert the names of excluded classes to packages with class names -->
97         <pathconvert property="it_classes" pathsep=" " refid="it_sources">
98                 <chainedmapper>
99                         <globmapper from="${basedir}/*" to="*"/>
100                         <mapper type="package" from="*.as" to="*"/>
101                 </chainedmapper>
102         </pathconvert>
103
104         <fileset id="hxasm_sources" dir="${basedir}/hxasm/" />
105         <!-- convert the names of excluded classes to packages with class names -->
106         <pathconvert property="hxasm_classes" pathsep=" " refid="hxasm_sources">
107                 <chainedmapper>
108                         <globmapper from="${basedir}/*" to="*"/>
109                         <mapper type="package" from="*.as" to="*"/>
110                 </chainedmapper>
111         </pathconvert>
112
113         <!-- if we end up with third-party stuff in the net/ folder, then do something like this -->
114         <!-- <fileset id="net_sources" dir="${basedir}/net/">
115                <exclude name="**net.systemeD**"/>
116         </fileset> -->
117
118         <!-- echo the exlcusions for debugging purposes -->
119         <!--<echo message="manifests = ${org_classes} ${it_classes} ${hxasm_classes}"/>-->
120   </target>
121
122 </project>