blob: a01d4f9fdd96cc92beddd3ac05e1c61b49cde541 [file] [log] [blame]
lmandel3a4ece92005-07-11 20:05:31 +00001<?xml version="1.0" encoding="UTF-8"?>
2
david_williams940d2772007-07-01 06:33:40 +00003<project
david_williams513cfdd2007-12-09 04:34:24 +00004 name="javadoc"
david_williams940d2772007-07-01 06:33:40 +00005 default="main"
6 basedir=".">
lmandel3a4ece92005-07-11 20:05:31 +00007
david_williams513cfdd2007-12-09 04:34:24 +00008 <!-- = = = standard properties pattern = = = -->
9 <!--
10 First get environment variables
11 Note to be cross-platform, "environment variables" are only appropriate for
12 some variables, e.g. ones we set, since properties are case sensitive, even if
13 the environment variables on your operating system are not, e.g. it will
14 be ${env.Path} not ${env.PATH} on Windows -->
15 <property environment="env" />
16
17 <!--
18 Let users override standard properties, if desired.
19 If this directory/files does not exist, then it will be ignored,
20 and defaults used.
21 -->
22 <property
23 file="${env.LOCAL_BUILD_PROPERTIES_DIR}/${ant.project.name}.properties" />
24
25
26 <!-- if not otherwise set externally, assign some reasonable default, especially
27 to work on production build machine -->
28 <property
29 name="JAVADOC_COMMAND"
30 value="${env.JAVA_5_HOME}/bin/javadoc" />
31 <property
32 name="JAVADOC_ARGS"
33 value="-J-Xms256m -J-Xmx1024m" />
lmandel3a4ece92005-07-11 20:05:31 +000034
david_williams940d2772007-07-01 06:33:40 +000035 <property file="javadoc.properties" />
36 <property
37 name="outputDir"
38 value="${basedir}" />
lmandel3a4ece92005-07-11 20:05:31 +000039
david_williams940d2772007-07-01 06:33:40 +000040 <target
41 name="main"
42 depends="prephtml, javadoc, packagetoc"
43 description="Builds Plugin Javadoc" />
44
45 <target
46 name="prephtml"
47 description="Transforms XML to HTML.">
48 <xslt
49 style="javadoc.xsl"
50 destdir=".."
51 basedir=".."
52 includes="**/overview.xml,**/package.xml"
53 excludes="**/build/*,**/@dot/**,**/bin**" />
54 </target>
lmandel3a4ece92005-07-11 20:05:31 +000055
56 <target name="javadoc">
david_williamsd7ef00b2007-12-09 01:52:56 +000057 <echo message="classpath: ${J2SE-1.5}" />
david_williams940d2772007-07-01 06:33:40 +000058 <echo message="buildDirectory: ${buildDirectory}" />
david_williamsd7ef00b2007-12-09 01:52:56 +000059 <echo message="JAVADOC_COMMAND: ${JAVADOC_COMMAND}" />
60 <echo message="JAVADOC_ARGS: ${JAVADOC_ARGS}" />
lmandel3a4ece92005-07-11 20:05:31 +000061
david_williams940d2772007-07-01 06:33:40 +000062 <mkdir dir="${outputDir}/reference/api/overview" />
63
64 <copy
65 todir="${outputDir}/reference/api/overview"
66 flatten="true">
67 <fileset dir="${basedir}/api-overview/overview/" />
68 <fileset
69 dir="${basedir}/.."
70 includes="*/javadoc-images/*.jpg" />
71 </copy>
72 <javadoc
david_williamsd7ef00b2007-12-09 01:52:56 +000073 executable="${JAVADOC_COMMAND}"
david_williams940d2772007-07-01 06:33:40 +000074 access="public"
75 author="false"
76 destdir="${outputDir}/reference/api"
77 doctitle="${api.title}"
78 nodeprecated="false"
79 nodeprecatedlist="false"
80 noindex="false"
81 nonavbar="false"
82 notree="false"
david_williams8c18e0e2007-07-01 07:15:47 +000083 Encoding="ISO-8859-1"
david_williams940d2772007-07-01 06:33:40 +000084 overview="${basedir}/api-overview/overview.html"
85 packagenames="${api.packages}"
86 sourcepath="${plugin.sourcefolders}"
87 splitindex="true"
88 use="true"
89 version="true"
90 breakiterator="yes"
91 verbose="false"
92 failonerror="false">
david_williamsd7ef00b2007-12-09 01:52:56 +000093 <arg line="${JAVADOC_ARGS}"/>
david_williams940d2772007-07-01 06:33:40 +000094 <classpath>
david_williamsd7ef00b2007-12-09 01:52:56 +000095 <pathelement path="${J2SE-1.5}" />
david_williams940d2772007-07-01 06:33:40 +000096 <fileset dir="${buildDirectory}/../eclipse/plugins">
97 <include name="**/*.jar" />
98 </fileset>
99 <dirset dir="${buildDirectory}">
100 <include name="**/@dot/**/*.class" />
101 </dirset>
102 <dirset dir="${buildDirectory}">
103 <include name="**/bin/**/*" />
104 </dirset>
105 </classpath>
106
107 </javadoc>
108 </target>
109
110 <target name="packagetoc">
111 <loadfile
112 failonerror="false"
113 property="wtp.packages"
114 srcFile="${outputDir}/reference/api/package-list">
115 <filterchain>
116 <filterreader
117 classname="org.apache.tools.ant.filters.PrefixLines">
118 <param
119 name="prefix"
120 value="&lt;/package&gt;&lt;package&gt;" />
121 </filterreader>
122 <striplinebreaks />
123 </filterchain>
124 </loadfile>
125
126 <!-- Create packages.xml file -->
127 <echo file="packages.xml">
128 &lt;packages&gt;&lt;package&gt;${wtp.packages}&lt;/package&gt;&lt;/packages&gt;
129 </echo>
130
131 <xslt
132 basedir="${basedir}"
133 in="packages.xml"
134 out="javadoctoc.xml"
135 style="javadocToc.xsl">
136 <outputproperty
137 name="method"
138 value="xml" />
139 <outputproperty
140 name="indent"
141 value="yes" />
142 </xslt>
143 </target>
lmandel3a4ece92005-07-11 20:05:31 +0000144</project>