Servoy 7.x.x Documentation
Child pages
  • Documenting the Plugin API

Versions Compared

Old Version 2

changes.mady.by.user Jan Blok

Saved on

compared with

New Version 3

changes.mady.by.user Jan Blok

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In Servoy 6.1 the way to provide documentation (ToolTips, SampleCode & Parameter info) for (3rd party) plugins in Servoy Developer has changed. Instead of providing the relevant information through the methods of the IScriptObject interface, A special Java eclipse plugin was create 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 generated XML file needs to be bundled with the plugin, which then will be used in Servoy Developer to provide the information to the developer using the plugin.

...