[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [wtp-dev] SDK Documentation


Hi David,

Good job! Thanks for working on this.

One question does this strictly apply to the java source? or are we talking also about the extension point documentation for the plugins?

Best Regards,
-- --
Mr. Angel Vera
  Server Tools Developer for WTP and Rational
  Lotus Notes: Angel Vera/Toronto/IBM@IBMCA
  Tel: 905-413-5919 - E-Mail: arvera@xxxxxxxxxx
-----
Those who think that something is impossible,
should not interfere with those who are willing to do it. - Angel Vera



David Carver <dcarver@xxxxxxxxxxxxxxxx>
Sent by: wtp-dev-bounces@xxxxxxxxxxx

07/24/2008 10:42 AM

Please respond to
"General discussion of project-wide or architectural issues."        <wtp-dev@xxxxxxxxxxx>

To
WTP Incubator Dev list <wtp-incubator-dev@xxxxxxxxxxx>, "General discussion of project-wide or architectural issues." <wtp-dev@xxxxxxxxxxx>
cc
Subject
[wtp-dev] SDK Documentation





I've managed to automate the generation of the SDK documentation
(JavaDoc) for the Eclipse Help plugins.   See bug 232547 for more
information.   It generates all the HTML files for the class files.   It
currently uses a doclet called JELDoclet to produce a xml file of the
java doc, and then creates the rest of the files from there.    There is
an ANT build script that does all the hard work, along with two
xslts.    Technically, this could also be done if somebody were to write
a custom Eclipse Doclet that produced the necessary files.

Anyways, this isn't limited to just XSL Tools, the same process could be
used across WTP or eclipse projects to generate the appropriate Toc.xml
and corresponding Html files for the help system.

Dave

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