Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 05320dfce72ca1e9b24d7b120ff7eef8565cc675 (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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:antcontrib="antlib:net.sf.antcontrib" default="build.docs">
	<taskdef uri="antlib:net.sf.antcontrib"
		resource="net/sf/antcontrib/antlib.xml"
	    classpath="${lib}/ant-contrib.jar"/>	

<!-- Note that this script is called from the automated build system and expects
     the following properties to be passed in:
     	javadoc.exe
     	buildRoot
     	buildDirectory
     	fullEmfVersion (needed until EMF packages their documentation in single jar)
     
     Also note that it is expected that this script is called as part of the 
     automated build, and particularly that the SDK component has been built
     and installed into the target eclipse, along with GMF's dependencies.
-->

	<property name="doc.plugin.dir" value="${buildDirectory}/plugins/org.eclipse.gmf.doc" />
	<property name="javadoc.location" value="${doc.plugin.dir}/reference/api"/>
	<property name="javadoc.link.location" value="${buildDirectory}/javadoc.link.location"/>
	
	<target name="build.docs" depends="init" description="Build GMF documentation">
		<antcall target="javadoc"/>
		<antcall target="convertSchemaToHtml"/>
	</target>
	
	<target name="init">
		<delete dir="${javadoc.location}" />
		<delete dir="${javadoc.link.location}" />
	</target>
	
	<target name="computeClasspath" unless="javadoc.classpath">
		<!-- Construct the javadoc classpath and store it in a property. -->
		<echo level="info" message="Computing classpath ..."/>
		
		<!-- Add platform dependencies required by your plug-in here.
			 Note that this pattern expects GMF and its dependencies to have 
			 been installed into the platform directory structure, as is
			 the case during the build. -->
		<patternset id="platform.classpath.pattern">

			<include name="**/org.eclipse.core*.jar"/>
			<include name="**/org.eclipse.core*/**/*.jar"/>
			<include name="**/org.eclipse.emf*.jar"/>
			<include name="**/org.eclipse.emf*/**/*.jar"/>
        	<include name="**/org.eclipse.swt*.jar"/>
        	<include name="**/org.eclipse.swt*/**/*.jar"/>
        	<include name="**/org.eclipse.ui*.jar"/>
        	<include name="**/org.eclipse.ui*/**/*.jar"/>
        	<include name="**/org.eclipse.update*.jar"/>
        	<include name="**/org.eclipse.update*/**/*.jar"/>
        	<include name="**/org.eclipse.osgi*.jar"/>
        	<include name="**/org.eclipse.osgi*/**/*.jar"/>
        	<include name="**/org.eclipse.equinox*.jar"/>
        	<include name="**/org.eclipse.equinox*/**/*.jar"/>
        	<include name="**/org.eclipse.jdt*.jar"/>
        	<include name="**/org.eclipse.jdt*/**/*.jar"/>
        	<include name="**/org.eclipse.jface*.jar"/>
        	<include name="**/org.eclipse.jface*/**/*.jar"/>
        	<include name="**/org.eclipse.text*.jar"/>
        	<include name="**/org.eclipse.text*/**/*.jar"/>
        	<include name="**/org.eclipse.team*.jar"/>
        	<include name="**/org.eclipse.team*/**/*.jar"/>
        	<include name="**/org.eclipse.draw2d*.jar"/>
        	<include name="**/org.eclipse.draw2d*/**/*.jar"/>
        	<include name="**/org.eclipse.gef*.jar"/>
        	<include name="**/org.eclipse.gef*/**/*.jar"/>
        	<include name="**/org.junit*.jar"/>
        	<include name="**/org.junit*/**/*.jar"/>
        	
        	<include name="**/org.eclipse.gmf*.jar"/>
           	<include name="**/org.eclipse.gmf*/**/*.jar"/>
        	<include name="**/org.apache.batik*.jar"/>
        	<include name="**/org.apache.batik*/**/*.jar"/>

			<include name="**/com.ibm.icu*.jar"/>
           	
		</patternset>
			
		<pathconvert property="javadoc.classpath" targetos="unix">
			<path>				
				<fileset dir="${baseLocation}">
					<patternset refid="platform.classpath.pattern"/>
		    	</fileset>
			</path>
		</pathconvert>
		<echo level="info" message="Done computing classpath."/>
		<echo level="debug" message="Classpath is: ${javadoc.classpath}"/>
	</target>
	
	<target name="extractLinks">
		<mkdir dir="${javadoc.link.location}"/>
		
		<patternset id="package.list">
			<include name="**/package-list"/>
		</patternset>
		
		<!-- We only need the package-list files out of these -->
		<unzip dest="${javadoc.link.location}/draw2d/">
			<patternset refid="package.list"/>
			<fileset dir="${baseLocation}/plugins">
				<include name="org.eclipse.draw2d.doc.isv*.jar"/>
			</fileset>
		</unzip>
		
		<unzip dest="${javadoc.link.location}/gef/">
			<patternset refid="package.list"/>
			<fileset dir="${baseLocation}/plugins">
				<include name="org.eclipse.gef.doc.isv*.jar"/>
			</fileset>
		</unzip>
		
		<unzip dest="${javadoc.link.location}/emf/">
			<patternset refid="package.list"/>			
			<fileset dir="${baseLocation}/plugins/org.eclipse.emf.doc_${fullEmfVersion}.v${emfBuildDate}${emfBuildTime}">
				<include name="doc.zip"/>
			</fileset>
		</unzip>
		
		<unzip dest="${javadoc.link.location}/emf.query/">
			<patternset refid="package.list"/>
			<fileset dir="${baseLocation}/plugins">
				<include name="org.eclipse.emf.query.doc*.jar"/>
			</fileset>
		</unzip>

		<unzip dest="${javadoc.link.location}/emf.transaction/">
			<patternset refid="package.list"/>
			<fileset dir="${baseLocation}/plugins">
				<include name="org.eclipse.emf.transaction.doc*.jar"/>
			</fileset>
		</unzip>
		
		<unzip dest="${javadoc.link.location}/emf.validation/">
			<patternset refid="package.list"/>
			<fileset dir="${baseLocation}/plugins">
				<include name="org.eclipse.emf.validation.doc*.jar"/>
			</fileset>
		</unzip>
		
		<unzip dest="${javadoc.link.location}/emf.workspace/">
			<patternset refid="package.list"/>
			<fileset dir="${baseLocation}/plugins">
				<include name="org.eclipse.emf.workspace.doc*.jar"/>
			</fileset>
		</unzip>

		<unzip dest="${javadoc.link.location}/emf.ocl/">
			<patternset refid="package.list"/>
			<fileset dir="${baseLocation}/plugins">
				<include name="org.eclipse.emf.ocl.doc*.jar"/>
			</fileset>
		</unzip>

		<unzip dest="${javadoc.link.location}/ocl/">
			<patternset refid="package.list"/>
			<fileset dir="${baseLocation}/plugins">
				<include name="org.eclipse.ocl.doc*.jar"/>
			</fileset>
		</unzip>
		
		<unzip dest="${javadoc.link.location}/platform/">
			<patternset refid="package.list"/>
			<fileset dir="${baseLocation}/plugins">
				<include name="org.eclipse.platform.doc.isv*.jar"/>
			</fileset>
		</unzip>
	</target>
	
	<target name="javadoc" depends="extractLinks,computeClasspath">
		
		<!-- Add your plug-ins to one of the "subsystem" (domain) doc sets below or, if
		     necessary, create a new doc set. Order matters, please add subsystems 
		     according to layer order -->
	
		<javadoc-subsystem subsystem="runtime" tocTitle="Runtime">
			<package-sets>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.core/src">
		    		<exclude name="org/eclipse/gmf/runtime/common/core/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui/src">
		    		<!-- explictly adding each package, as exclude list with multiple doesn't seem to work as imagined -->
		    		<include name="org/eclipse/gmf/runtime/common/ui/action/**,org/eclipse/gmf/runtime/common/ui/contentassist/**,org/eclipse/gmf/runtime/common/ui/dialogs/**,org/eclipse/gmf/runtime/common/ui/editors/**,org/eclipse/gmf/runtime/common/ui/plugin/**,org/eclipse/gmf/runtime/common/ui/preferences/**,org/eclipse/gmf/runtime/common/ui/resources/**,org/eclipse/gmf/runtime/common/ui/util/**,org/eclipse/gmf/runtime/common/ui/viewers/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.action/src">
		    		<exclude name="org/eclipse/gmf/runtime/common/ui/action/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.action.ide/src">
		    		<exclude name="org/eclipse/gmf/runtime/common/ui/action/ide/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.printing/src">
		    		<exclude name="org/eclipse/gmf/runtime/common/ui/printing/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.printing.win32/src"/>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.services/src">
		    		<exclude name="org/eclipse/gmf/runtime/common/ui/services/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.services.action/src">
		    		<exclude name="org/eclipse/gmf/runtime/common/ui/services/action/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.services.dnd/src">
		    		<exclude name="org/eclipse/gmf/runtime/common/ui/services/dnd/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.services.dnd.ide/src">
		    		<exclude name="org/eclipse/gmf/runtime/common/ui/services/dnd/ide/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.services.properties/src">
		    		<exclude name="org/eclipse/gmf/runtime/common/ui/services/properties/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.draw2d.ui/src">
		    		<exclude name="org/eclipse/gmf/runtime/draw2d/ui/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.draw2d.ui.render/src">
		    		<exclude name="org/eclipse/gmf/runtime/draw2d/ui/render/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.draw2d.ui.render.awt/src">
					<exclude name="org/eclipse/gmf/runtime/draw2d/ui/render/awt/internal/**"/>
				</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.gef.ui/src">
		    		<exclude name="org/eclipse/gmf/runtime/gef/ui/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.commands.core/src">
		    		<exclude name="org/eclipse/gmf/runtime/emf/commands/core/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.core/src">
		    		<exclude name="org/eclipse/gmf/runtime/emf/core/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.ui/src">
		    		<exclude name="org/eclipse/gmf/runtime/emf/ui/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.ui.properties/src">
		    		<exclude name="org/eclipse/gmf/runtime/emf/ui/properties/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.clipboard.core/src">
		    		<exclude name="org/eclipse/gmf/runtime/emf/clipboard/core/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.type.core/src">
		    		<exclude name="org/eclipse/gmf/runtime/emf/type/core/internal/**"/>
		    	</packageset>
		    	<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.type.ui/src">
		    		<exclude name="org/eclipse/gmf/runtime/emf/type/ui/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.notation/src">
		    		<exclude name="org/eclipse/gmf/runtime/notation/providers/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.core/src">
		    		<exclude name="org/eclipse/gmf/runtime/diagram/core/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui/src">
					<!-- explictly adding each package, as exclude list with multiple doesn't seem to work as imagined -->
		    		<include name="org/eclipse/gmf/runtime/diagram/ui/*.java,org/eclipse/gmf/runtime/diagram/ui/actions/**,org/eclipse/gmf/runtime/diagram/ui/commands/**,org/eclipse/gmf/runtime/diagram/ui/dialogs/**,org/eclipse/gmf/runtime/diagram/ui/editparts/**,org/eclipse/gmf/runtime/diagram/ui/figures/**,org/eclipse/gmf/runtime/diagram/ui/handles/**,org/eclipse/gmf/runtime/diagram/ui/help/**,org/eclipse/gmf/runtime/diagram/ui/image/**,org/eclipse/gmf/runtime/diagram/ui/menus/**,org/eclipse/gmf/runtime/diagram/ui/parts/**,org/eclipse/gmf/runtime/diagram/ui/preferences/**,org/eclipse/gmf/runtime/diagram/ui/properties/**,org/eclipse/gmf/runtime/diagram/ui/providers/**,org/eclipse/gmf/runtime/diagram/ui/requests/**,org/eclipse/gmf/runtime/diagram/ui/services/**,org/eclipse/gmf/runtime/diagram/ui/tools/**,org/eclipse/gmf/runtime/diagram/ui/util/**,org/eclipse/gmf/runtime/diagram/ui/view/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui.dnd/src"/>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui.geoshapes/src">
		    		<exclude name="org/eclipse/gmf/runtime/diagram/ui/geoshapes/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui.printing/src">
		    		<exclude name="org/eclipse/gmf/runtime/diagram/ui/printing/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui.properties/src"/>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui.providers/src">
		    		<exclude name="org/eclipse/gmf/runtime/diagram/ui/providers/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui.providers.ide/src">
		    		<exclude name="org/eclipse/gmf/runtime/diagram/ui/providers/ide/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui.resources.editor/src">
		    		<exclude name="org/eclipse/gmf/runtime/diagram/ui/resources/editor/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui.resources.editor.ide/src"/>
			</package-sets>
				<package-groups>
					<group title="Common Core Packages" packages="org.eclipse.gmf.runtime.common.core*"/>
					<group title="Common UI Packages" packages="org.eclipse.gmf.runtime.common.ui*"/>
					<group title="Draw2D Packages" packages="org.eclipse.gmf.runtime.draw2d*"/>
					<group title="EMF Modeling Services Layer Packages" packages="org.eclipse.gmf.runtime.emf*"/>
					<group title="EMF Clipboard Support Packages" packages="org.eclipse.gmf.runtime.emf.clipboard.core*"/>
					<group title="EMF Element Type Framework Packages" packages="org.eclipse.gmf.runtime.emf.type.core*"/>
					<group title="GEF Packages" packages="org.eclipse.gmf.runtime.gef*"/>
					<group title="Diagram Core Packages" packages="org.eclipse.gmf.runtime.diagram.core*"/>
					<group title="Diagram Notation Packages" packages="org.eclipse.gmf.runtime.notation*"/>
					<group title="Diagram UI Packages" packages="org.eclipse.gmf.runtime.diagram.ui*"/>
			</package-groups>
		</javadoc-subsystem>
		<generate-toc subsystem="runtime" title="GMF Runtime"/>

		<javadoc-subsystem subsystem="tooling" tocTitle="Generation Framework">
			<package-sets>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.common/src">
	    		<exclude name="org/eclipse/gmf/internal/**"/>
	    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.tooldef/src">
	    		<exclude name="org/eclipse/gmf/internal/**"/>
	    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.tooldef.edit/src">
		    		<exclude name="org/eclipse/gmf/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.map/src">
	    		<exclude name="org/eclipse/gmf/internal/**"/>
	    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.map.edit/src">
		    		<exclude name="org/eclipse/gmf/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.bridge/src">
		    		<exclude name="org/eclipse/gmf/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.codegen/src">
		    		<exclude name="org/eclipse/gmf/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.codegen.edit/src">
		    		<exclude name="org/eclipse/gmf/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.codegen.ui/src">
		    		<exclude name="org/eclipse/gmf/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.graphdef/src">
		    		<exclude name="org/eclipse/gmf/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.graphdef.codegen/src">
		    		<exclude name="org/eclipse/gmf/internal/**"/>
		    	</packageset>
				<packageset dir="${buildRoot}/sdk/plugins/org.eclipse.gmf.graphdef.edit/src">
		    		<exclude name="org/eclipse/gmf/internal/**"/>
		    	</packageset>
			</package-sets>
			<package-groups>
				<group title="Tooling Packages" packages="org.eclipse.gmf.tooldef*,org.eclipse.gmf.map*,org.eclipse.gmf.bridge*,org.eclipse.gmf.codegen*,org.eclipse.gmf.internal.codegen*,org.eclipse.gmf.graphdef*,org.eclipse.gmf.gmfgraph*"/>
			</package-groups>
		</javadoc-subsystem>
		<generate-toc subsystem="tooling" title="GMF Generation Framework"/>
		
		<!-- Add your plug-ins to one of the "subsystem" (domain) doc sets above or, if
		     necessary, create a new doc set. -->

		
    </target>
	
    <!--
		Builds the Javadoc set for a subsystem (often corresponds to a "domain").
		
		attributes:
			subsystem - the name of the subsystem, used in the directory where its Javadocs are generated to
			tocTitle - Title to add to the generated TOC
			tocLinkTo - Path to link generated TOC to (Optional)
					
		elements:
			package-sets - a set of <packageset> elements specifying the "src/" directories of the plug-ins included in the subsystem
			package-groups - a set of <group> elements specifying package groups.  Callers should include at least one group
			bottom - the bottom copyright element to appear for the subsystem
    -->
	<macrodef name="javadoc-subsystem">
		<attribute name="subsystem"/>
		<attribute name="tocTitle"/>
		<attribute name="tocLinkTo" default=" "/>
		<element name="package-sets"/>
		<element name="package-groups"/>
		
		<sequential>
			<delete dir="${doc.plugin.dir}/reference/api/@{subsystem}"/>
			<mkdir dir="${doc.plugin.dir}/reference/api/@{subsystem}"/>

			<echo level="info" message="***"/>
			<echo level="info" message="*** Building javadoc for subsystem @{subsystem}"/>
			<echo level="info" message="***"/>
		
	 		<javadoc 
	 			access="protected"
				additionalparam="-breakiterator"
				maxmemory="512M"
				classpath="${javadoc.classpath}"
				useexternalfile="true"
				author="false"
	        	destdir="${doc.plugin.dir}/reference/api/@{subsystem}"
	 			windowtitle="Eclipse GMF Documentation"
	 			source="1.5" 
	        	noindex="false"
	        	nonavbar="false"
	        	notree="false"
	        	splitindex="true"
	        	stylesheetfile="${doc.plugin.dir}/stylesheet.css"
	        	use="true"
	        	version="false">
				    <doctitle><![CDATA[<h2>Eclipse Graphical Modeling Framework (GMF)</h2><h2>@{tocTitle} API Specification</h2>]]></doctitle>				    
	 				<bottom><![CDATA[<font size="-1"><p><a href="/help/topic/org.eclipse.platform.doc.isv/reference/misc/api-usage-rules.html">Guidelines for using Eclipse APIs</a>.</p><p>Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.</font></p>]]></bottom>	
	 				<header><![CDATA[@{tocTitle}]]></header>
	 				<tag name="generated" scope="all" description="** Generated **"/>
	 				<tag name="ordered" scope="all" description="Ordered:"/>
	 				<tag name="model" scope="all" description="Model:"/>
					<package-groups/>
	 				<link offline="true" href="http://java.sun.com/j2se/1.5.0/docs/api/" packagelistLoc="/java/j2sdk1.5/docs/api/"/>
					<link offline="true" href="/help/topic/org.eclipse.emf.doc/references/javadoc/" packagelistLoc="${javadoc.link.location}/emf/references/javadoc/"/>
					<link offline="true" href="/help/topic/org.eclipse.emf.query.doc/references/javadoc/" packagelistLoc="${javadoc.link.location}/emf.query/references/javadoc/"/>
					<link offline="true" href="/help/topic/org.eclipse.emf.transaction.doc/references/javadoc/" packagelistLoc="${javadoc.link.location}/emf.transaction/references/javadoc/"/>
					<link offline="true" href="/help/topic/org.eclipse.emf.validation.doc/references/javadoc/" packagelistLoc="${javadoc.link.location}/emf.validation/references/javadoc/"/>
					<link offline="true" href="/help/topic/org.eclipse.emf.workspace.doc/references/javadoc/" packagelistLoc="${javadoc.link.location}/emf.workspace/references/javadoc/"/>
					<link offline="true" href="/help/topic/org.eclipse.emf.ocl.doc/references/javadoc/" packagelistLoc="${javadoc.link.location}/emf.ocl/references/javadoc/"/>
					<link offline="true" href="/help/topic/org.eclipse.ocl.doc/references/javadoc/" packagelistLoc="${javadoc.link.location}/ocl/references/javadoc/"/>
					<link offline="true" href="/help/topic/org.eclipse.platform.doc.isv/reference/api/" packagelistLoc="${javadoc.link.location}/platform/reference/api/"/>
					<link offline="true" href="/help/topic/org.eclipse.platform.doc.isv/reference/osgi/" packagelistLoc="${javadoc.link.location}/platform/reference/osgi/"/>
					<link offline="true" href="/help/topic/org.eclipse.draw2d.doc.isv/reference/api/" packagelistLoc="${javadoc.link.location}/draw2d/reference/api/"/>
					<link offline="true" href="/help/topic/org.eclipse.gef.doc.isv/reference/api/" packagelistLoc="${javadoc.link.location}/gef/reference/api/"/>
					<!-- Links to other doc sets in GMF -->
					<link offline="true" href="/help/topic/org.eclipse.gmf.runtime.doc.isv/reference/api/runtime" packagelistLoc="${doc.plugin.dir}/reference/api/runtime/"/>
	 				<link offline="true" href="/help/topic/org.eclipse.gmf.runtime.doc.isv/reference/api/tooling" packagelistLoc="${doc.plugin.dir}/reference/api/tooling/"/>
			    	<package-sets/>
			</javadoc>
		</sequential>
    </macrodef>

	<target name="convertSchemaToHtml">
		<property name="schema-destination" value="${doc.plugin.dir}/reference/extension-points" />

		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.core/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.services.action/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.services/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.services.dnd/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.common.ui.services.properties/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.core/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.ui/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.clipboard.core/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.emf.type.core/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.draw2d.ui.render/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.core/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui/plugin.xml" destination="${schema-destination}" />
		<pde.convertSchemaToHTML manifest="${buildRoot}/sdk/plugins/org.eclipse.gmf.runtime.diagram.ui.resources.editor/plugin.xml" destination="${schema-destination}" />
		
	</target>

	<macrodef name="generate-toc">
		<attribute name="subsystem"/>
		<attribute name="title"/>
		<sequential>
	        <echo file="${doc.plugin.dir}/toc-@{subsystem}.xml" append="false"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>]]>                                                                                                                                               
<![CDATA[<?NLS TYPE="org.eclipse.help.toc"?>]]>                                                                                                                               
	<![CDATA[<toc label="Reference">]]>
		<![CDATA[<topic]]> label="@{title}" href="reference/api/@{subsystem}/overview-summary.html"<![CDATA[>]]>
	        </echo>
        	<antcontrib:for param="file">
        	    <path>
        	        <fileset dir="${doc.plugin.dir}/reference/api/@{subsystem}" includes="**/package-summary.html" />
        	    </path>
        	<sequential>
				<antcontrib:propertyregex property="package.path"                                                                                                               
					input="@{file}"                                                                                                                                                              
					regexp="/reference/api/@{subsystem}/(.*)/package-summary.html"                                                                                                                          
					select="\1"                                                                                                                                                                  
					override="true"/>  
				<antcontrib:propertyregex property="package.name"                                                                                                                            
					input="${package.path}"                                                                                                                                                              
					regexp="([^/]*)/"                                                                                                                                                        
					replace="\1\."                                                                                                                                                                  
					override="true"/>                                                                                                                                                            
                <echo file="${doc.plugin.dir}/toc-@{subsystem}.xml" append="true">
    		<![CDATA[<topic]]> label="${package.name}" href="reference/api/@{subsystem}/${package.path}/package-summary.html"<![CDATA[/>]]>
    			</echo>
			</sequential>
        	</antcontrib:for>    											        
			<echo file="${doc.plugin.dir}/toc-@{subsystem}.xml" append="true">
		<![CDATA[</topic>]]>
	<![CDATA[</toc>]]>
	        </echo>
		</sequential>
	</macrodef>
        	
</project>

Back to the top