Skip to main content
summaryrefslogtreecommitdiffstats
blob: 7eadaf1a45af487f803eb979e632967f08b54671 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
<?xml version="1.0" encoding="UTF-8"?>
<project name="Plugin Javadoc" default="javadoc">
	<property name="destDir"    value="doc"/>
	<property name="classpath"  value="bin"/>
	<property name="overview"   value="build/overview.html"/>
	<property name="eclipseDir" value="."/>
	<property name="docjar" value="org.eclipse.platform.doc.isv.jar"/>
	
	<!-- other properties that must be passed to this script include:
		 windowTitle
		 groupTitle 
	-->
	
	<property environment="env"/>
	<property name="javaHome" value="${env.JAVA_HOME}"/>
	
	<property name="javadoc.link.location" value="${eclipseDir}/javadoc"/>
	<available property="platformJavadocExists" file="${javadoc.link.location}/platform/"/>

	<!-- TODO Enable linking to the platform javadoc -->
	<!-- <target name="extractPlatformJavadoc" unless="platformJavadocExists">
		<exec executable="find">
		   <arg value="${eclipseDir}/.."/>
		   <arg value="-type"/>
		   <arg value="d"/>
		   <arg value="-name"/>
		   <arg value="javadoc"/>
		</exec>
		<unzip src="${eclipseDir}/@docjar@" dest="${javadoc.link.location}/platform/"/>
	</target> -->

	<!-- TODO Enable linking to the platform javadoc -->
	<!-- <target name="javadoc" depends="extractPlatformJavadoc"> -->
	
	<target name="javadoc">
		<javadoc 
			destdir="${destDir}" 
			classpath="${classpath}"
			overview="${overview}"

			windowtitle="${windowTitle}"
			footer="Copyright 2006 IBM Corporation and others.&lt;br&gt; All Rights Reserved."

			access="protected" 
			additionalparam="-breakiterator -tag model:X -tag generated:X -tag ordered:X"
			author="false"
			breakiterator="true"
			charset="UTF-8"
			docencoding="UTF-8"
			nodeprecated="false"
			nodeprecatedlist="false" 
			noindex="false" 
			nonavbar="false" 
			notree="false" 
			source="1.4"
			splitindex="true" 
			use="true" 
			version="true"> 
				<arg value="-J-Xmx256m"/>
				
				<link offline="true" href="http://java.sun.com/j2se/1.4/docs/api/" packagelistLoc="${javaHome}/docs/api/"/>
				<!-- TODO Enable link to platform documentation -->
				<!-- <link offline="true" href="/help/topic/org.eclipse.platform.doc.isv/reference/api/" packagelistLoc="${javadoc.link.location}/platform/reference/api/"/> -->
				
				<tag name="ignore"     description="ignore" enabled="false"/>
				<tag name="generated"  description="ignore" enabled="false"/>
				<tag name="model"      description="ignore" enabled="false"/>
				<tag name="modifiable" description="ignore" enabled="false"/>
				<tag name="extends"    description="ignore" enabled="false"/>
				<tag name="implements" description="ignore" enabled="false"/>
				<tag name="ordered"    description="ignore" enabled="false"/>

				<!-- If you add a @ plugin @ below, don't forget to update the antjavadoc.sh file -->

				<group title="${groupTitle}" packages="@plugin@"/>
				
				<!-- If you add a @ plugin @ above, don't forget to update the antjavadoc.sh file -->

				@packagesets@
				
		</javadoc>
		
		<!-- make sure the doc-files are copied -->
		<macrodef name="copyDocFiles">
			<attribute name="pluginDir"/>
			<sequential>
				<copy todir="${destDir}" failonerror="false">
				        <fileset dir="@{pluginDir}/src" includes="**/doc-files/**"/>
				</copy>		
			</sequential>
		</macrodef>

		@copydocfiles@

	</target>
</project>

Back to the top