diff options
| author | gkarasiu | 2008-05-20 11:51:29 +0000 |
|---|---|---|
| committer | gkarasiu | 2008-05-20 11:51:29 +0000 |
| commit | 4b8a344146cd61fea44fa7599282f81141e0a1a3 (patch) | |
| tree | 5e82b42c7cbc685f04ce7c515a3b7041d315e13f /docs/org.eclipse.wst.validation.doc.isv/README.TXT | |
| parent | a3dea42c6654e6aa282152549ea2e3e5244f6ed3 (diff) | |
| download | webtools.common-4b8a344146cd61fea44fa7599282f81141e0a1a3.tar.gz webtools.common-4b8a344146cd61fea44fa7599282f81141e0a1a3.tar.xz webtools.common-4b8a344146cd61fea44fa7599282f81141e0a1a3.zip | |
[232769] Javadoc improvements
Diffstat (limited to 'docs/org.eclipse.wst.validation.doc.isv/README.TXT')
| -rw-r--r-- | docs/org.eclipse.wst.validation.doc.isv/README.TXT | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/org.eclipse.wst.validation.doc.isv/README.TXT b/docs/org.eclipse.wst.validation.doc.isv/README.TXT new file mode 100644 index 000000000..7e82c4736 --- /dev/null +++ b/docs/org.eclipse.wst.validation.doc.isv/README.TXT @@ -0,0 +1,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 + + |