Re: [wtp-dev] Generating WST SDK Documentation

[Gary Karasiuk <karasiuk@xxxxxxxxxx>]

Several of the projects, do generate
ISV doc, and they can be used as examples. I know in the case of the validation
framework, we produced a couple of build scripts, which generate our Javadoc
and our Extension doc. These scripts were run manually, when there were
major changes. The results of running the scripts were then checked into
CVS. I know that some other components were using the same approach.

Gary Karasiuk, RAD Performance Analyst
karasiuk@xxxxxxxxxx
TL-969-3985, external: (905)-413-3985

From:	David Carver <dcarver@xxxxxxxxxxxxxxxx>
To:	"General discussion of project-wide or architectural issues." <wtp-dev@xxxxxxxxxxx>
Date:	04/14/2009 09:55 AM
Subject:	[wtp-dev] Generating WST SDK Documentation
Sent by:	wtp-dev-bounces@xxxxxxxxxxx

---

Is there a standard way the WTP SDK documentation
is being generated?   
While going through the existing SDK, I noticed that WST particularly 
the source editing components are not documented.   I've opened bug
272053 to address this for the wst.xml component.   However, to 
correctly integrate this, I need to know the appropriate IDs that can be
used to plug into the existing SDK documentation catagories.

I checked the wiki but did not see this documented anywhere.   Also,
I 
did not see a place that describes the documentation process and how 
these are kept up to date.

I do have a process for XSL Tools that generates dynamically the toc.xml
as appropriate.  It can be enhanced further to allow plugging in the
documentation at various extension points.  We just need those ids
documented.

Ideally we should have the sdk documentation process as part of the 
build so that it kept up to date with the rest of the artifacts from the
build.

Dave

_______________________________________________
wtp-dev mailing list
wtp-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/wtp-dev