blob: 7e82c4736017d1c305d4b110eb7660023966187b (
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
|
----------------------------------------------------------------------------------
-- Generating JavaDoc and Extension Point Documentation for --
-- org.eclipse.wst.validation.doc.isv plug-in --
-- 2008/05/20 (GRK) --
----------------------------------------------------------------------------------
Intro:
This tool and readme was extracted from an example done by the JSF team. It was
then adopted to generate the JavaDocs and Ext-Pt for validation.
JavaDoc Generation Task
Intro:
The javadocBuild.xml file is used to create the reference javadocs. It hard codes the package
names into the Ant script, so if API packages are added or removed this will need to be updated.
Setup:
- ensure that the org.eclipse.wst.validation plug-in is present in the workspace
Generate:
1) select javadocBuild.xml file in project explorer
2) Run as "Ant Build..." --> JRE Tab, ensure that "Run in same JRE as Workspace" is selected
Sanity Test:
1) Directly select the API packages in the org.eclipse.wst.validation plug-in.
2) Use the Export->Javadoc command to generate javadoc into a temporary directory.
3) Examine the Console for warnings and errors. Fix as necessary.
Extension-point References Task
Intro:
The listed-ext-points property in buildExtDocs.properties file is used to generate
the HTML documentation from the schemas. This list must be verified for accuracy
and is not generated like the Javadoc API packages are.
Generate:
1) select buildExtDocs.xml file in project explorer
2) Run as "Ant Build..." --> JRE Tab, ensure that "Run in same JRE as Workspace" is
selected
Checking-in:
Check in:
- any changes made in this project
|
