Page History

...

Documenting the API

Servoy supplies a Java Eclipse Documentation Generator plugin to help with documenting the plugin API, in order to produce the required plugin api documentation XML file.

The plugin transforms you javadoc into XML for use by Servoy Developer.

the new mechanism allows the plugin developer to specify the relevant information through JavaDoc directly on the public methods and properties of the plugin and export those to a XML file using the Servoy Documentation Generator. The This plugin allows to transform your plugin JavaDoc into a Servoy plugin xml api file, the generated XML file needs to be bundled with the plugin, which . Which then will be used in Servoy Developer to provide the information to the developer using the plugin.

This change encompasses the deprecation of the IScriptObject interface and introduction of a new, empty IScriptable interface, which works together with the Documentation Generator plugin for Eclipse. 

The benefits of the change is largely for plugin developers: the new mechanism allows the developer to tie the documentation directly to the methods/properties in code, instead of in separate methodsAll the relevant API information can be supplied by JavaDoc directly on the public methods and properties of the plugin.

The IScriptable Interface

The IScriptable interface is an empty interface that classes that expose methods or properties to the JavaScript layer in Servoy have to implement. When plugins get loaded in Servoy Developer, for all classes that implement this interface, the documentation will be loaded. For more information refer to the IScriptable API doc in the Servoy API.

...