Plugins

JSDoc Serclipse plugin

v1.0.5

v1.0.5
Added links from calcs to globals.

v1.0.4
Added distinction between forms and calculations, fixed _global_ namespace to globals, fixed temp path appearing in jsdoc style. Thanks to Paul Bakker for pointing this out.

v1.0.3
Fixed issue with the category of the update site attached to wrong version of plugin.

v1.0.2
Fixed the jproton,js, ui,js and sh.js from the JProton Style JSDoc to be compliant to JavaScript Strict Mode and not generate warnings anymore.

v1.0.1
Added command, icon and key bindings

v1.0
First public release
 

A free Serclipse plugin (LGPL license) to generate the html documentation of your Servoy solutions.

This one will add a new "Generate JSDoc" capability to your Servoy developer environment.

Based on the JSDoc annotations that you can now add on your Servoy methods, it will automatically generate html documentation using an adapted version of the JsDoc Toolkit embedded in a Serclipse plugin for your convenience.

To use it, simply select a solution, then right click and choose "Generate JSDoc..." in the contextual menu:

By default, the documentation will be generated inside your solution's folder in your workspace in a folder named "docs" with a style called JProton.

If you want to change these default values, you can do so in the JsDoc preferences panel, just go in your preferences, and choose the JsDoc node:

Download packages:
There is no download package as such. You simply retrieve the plugin using the Eclipse plugin manager.

1/ In your preferences "Install/Update > Available Software Sites" and choose "Add...":

2/ Add a site with these informations:

Name: Servoy Stuff updates

Location: http://www.servoy-stuff.net/downloads/developer/updates

3/ Click OK, and make sure the site is "Enabled", then in your Help menu, choose "Install New Software..."

Choose to "Work with" the "Servoy Stuff updates" site, Eclipse will check the site, make sure your "Group items by category" is unchecked, you should see the "JSDoc Plugin" item:

4/ check it and click "Next >", then follow the instructions.

There is a companion Google-Code project where you will be able to submit issues/feature requests and check out the code from SVN

If you like this plugin, consider donating to help me make more cool stuff available!

You can send me a note with any comment, feature request, bug report, using the contact form.