[corona-dev] Corona Documentation plugins.

["Jaworowski, Piotr" <Piotr.Jaworowski@xxxxxxxxxxxxxxxx>]

Hi All,

           

            I’ve added one new feature and one new plug-in into corona CVS repository; it’s connected with enhancement https://bugs.eclipse.org/bugs/show_bug.cgi?id=157241.

 

            New stuff was added in new directory doc (structure like in EMFT), so currently CVS structure looks as follows:

 

           

            New plugin org.eclipse.corona.doc and new feature org.eclipse.corona.doc-feature provides “help” for Corona (currently there is only a welcome page and corona’s javadoc available).

 

            You can generate javadoc for corona using org.eclipse.corona.doc/build/antJavadoc.sh script, following environment variable have to be set up; ANT_HOME and JAVA_HOME (you can also modify paths in script). Script assumes that plug-in org.eclipse.corona.doc is on the same level as other corona plug-ins (you can simply import it into you Workspace). Additionally it requires one parameter which is eclipse home directory (./antJavadoc.sh >eclipse home directory<).

As you can notice that is a shell script, so it can be run under Linux, but If you’d like to generate it under windows, you can do it using cygwin shell www.cygwin.com. (the script is adapted for cygwin).

(e.g. My cygwin command for javadoc generation looks as follows: >./antJavadoc.sh /cygdrive/d/Projects/Corona/Eclipse<).

 

            The reason why it’s a shell script (not a bat) is that windows have a limitation regarding a command length. And command for javaDoc generatation for Corona requires more than 1024 characters.

 

Have a nice weekend,

Piotr

           

The contents of this e-mail are intended for the named addressee only. It contains information that may be confidential. Unless you are the named addressee or an authorized designee, you may not copy or use it, or disclose it to anyone else. If you received it in error please notify us immediately and then destroy it.