Child pages
  • Documenting the Plugin API

Versions Compared

Key

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

...

In order to have the method documentation available, in JavaScript, you must the documentation generation tool installed, in the Eclipse in which you are developing the plugin code (along with its documentation). The documentation generation tool must be installed via Eclipse update sites. From the Servoy Developer, via Help->Install New Software, add the http://www.servoy.com/documentbuilder url as an update site and install the documentation generator (Servoy Documentation Generator Feature). It will show up under installed software as the Servoy Documentation Generator Feature.

Note
titleNote

You might need to have "Group items by category" unchecked in the install new software first wizard page.

After the tool is installed, you can generate the documentation of a plugin, by selecting the project/package corresponding to that plugin and using the context menu Servoy->Generate Servoy Documentation XML. An file with the plugin's documentation, available in XML format, will be generated.

...