lmandel | 3a4ece9 | 2005-07-11 20:05:31 +0000 | [diff] [blame] | 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | |
david_williams | 940d277 | 2007-07-01 06:33:40 +0000 | [diff] [blame] | 3 | <project |
david_williams | 513cfdd | 2007-12-09 04:34:24 +0000 | [diff] [blame^] | 4 | name="javadoc" |
david_williams | 940d277 | 2007-07-01 06:33:40 +0000 | [diff] [blame] | 5 | default="main" |
| 6 | basedir="."> |
lmandel | 3a4ece9 | 2005-07-11 20:05:31 +0000 | [diff] [blame] | 7 | |
david_williams | 513cfdd | 2007-12-09 04:34:24 +0000 | [diff] [blame^] | 8 | <!-- = = = 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" /> |
lmandel | 3a4ece9 | 2005-07-11 20:05:31 +0000 | [diff] [blame] | 34 | |
david_williams | 940d277 | 2007-07-01 06:33:40 +0000 | [diff] [blame] | 35 | <property file="javadoc.properties" /> |
| 36 | <property |
| 37 | name="outputDir" |
| 38 | value="${basedir}" /> |
lmandel | 3a4ece9 | 2005-07-11 20:05:31 +0000 | [diff] [blame] | 39 | |
david_williams | 940d277 | 2007-07-01 06:33:40 +0000 | [diff] [blame] | 40 | <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> |
lmandel | 3a4ece9 | 2005-07-11 20:05:31 +0000 | [diff] [blame] | 55 | |
| 56 | <target name="javadoc"> |
david_williams | d7ef00b | 2007-12-09 01:52:56 +0000 | [diff] [blame] | 57 | <echo message="classpath: ${J2SE-1.5}" /> |
david_williams | 940d277 | 2007-07-01 06:33:40 +0000 | [diff] [blame] | 58 | <echo message="buildDirectory: ${buildDirectory}" /> |
david_williams | d7ef00b | 2007-12-09 01:52:56 +0000 | [diff] [blame] | 59 | <echo message="JAVADOC_COMMAND: ${JAVADOC_COMMAND}" /> |
| 60 | <echo message="JAVADOC_ARGS: ${JAVADOC_ARGS}" /> |
lmandel | 3a4ece9 | 2005-07-11 20:05:31 +0000 | [diff] [blame] | 61 | |
david_williams | 940d277 | 2007-07-01 06:33:40 +0000 | [diff] [blame] | 62 | <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_williams | d7ef00b | 2007-12-09 01:52:56 +0000 | [diff] [blame] | 73 | executable="${JAVADOC_COMMAND}" |
david_williams | 940d277 | 2007-07-01 06:33:40 +0000 | [diff] [blame] | 74 | 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_williams | 8c18e0e | 2007-07-01 07:15:47 +0000 | [diff] [blame] | 83 | Encoding="ISO-8859-1" |
david_williams | 940d277 | 2007-07-01 06:33:40 +0000 | [diff] [blame] | 84 | 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_williams | d7ef00b | 2007-12-09 01:52:56 +0000 | [diff] [blame] | 93 | <arg line="${JAVADOC_ARGS}"/> |
david_williams | 940d277 | 2007-07-01 06:33:40 +0000 | [diff] [blame] | 94 | <classpath> |
david_williams | d7ef00b | 2007-12-09 01:52:56 +0000 | [diff] [blame] | 95 | <pathelement path="${J2SE-1.5}" /> |
david_williams | 940d277 | 2007-07-01 06:33:40 +0000 | [diff] [blame] | 96 | <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="</package><package>" /> |
| 121 | </filterreader> |
| 122 | <striplinebreaks /> |
| 123 | </filterchain> |
| 124 | </loadfile> |
| 125 | |
| 126 | <!-- Create packages.xml file --> |
| 127 | <echo file="packages.xml"> |
| 128 | <packages><package>${wtp.packages}</package></packages> |
| 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> |
lmandel | 3a4ece9 | 2005-07-11 20:05:31 +0000 | [diff] [blame] | 144 | </project> |