Page 1 of 1

Missing JavaDoc for Servoy API

PostPosted: Thu Sep 08, 2016 11:42 pm
by goldcougar
The Wiki links to http://www.servoy.com/docs/public-api/ which redirects to servoy homepage. Where is the API javadoc now?

Re: Missing JavaDoc for Servoy API

PostPosted: Wed Nov 02, 2016 11:24 am
by jbrancoIF
Please, any news on this?

I'm currently converting from Servoy 5 to 8.1 and a lot of things changed. The documentation is not always as clear as it should on the wiki and then we have this links to nothing...

Re: Missing JavaDoc for Servoy API

PostPosted: Wed Nov 02, 2016 12:57 pm
by patrick
That link above points to the plugin API, so nothing that should be needed to convert a servoy solution. It needs to be fixed.

What parts of the documentation on the Wiki are not clear? Links in the wiki should all work.

Re: Missing JavaDoc for Servoy API

PostPosted: Wed Nov 02, 2016 1:05 pm
by rvanderburg

Re: Missing JavaDoc for Servoy API

PostPosted: Wed Nov 02, 2016 3:47 pm
by goldcougar
Thanks. Should probably update the link in the Wiki: https://wiki.servoy.com/display/public/ ... ing+Servoy

Re: Missing JavaDoc for Servoy API

PostPosted: Wed Nov 02, 2016 4:20 pm
by jbrancoIF
patrick wrote:That link above points to the plugin API, so nothing that should be needed to convert a servoy solution. It needs to be fixed.

What parts of the documentation on the Wiki are not clear? Links in the wiki should all work.


I'm also converting a plugin, with the new documentation using JavaDoc and API. Thanks for the new link rvanderburg.

From the top of my head, the part about the The Documentation Generator Tool is pretty light. You assume a lot of information from the user that someone that doesn't use it everyday wouldn't know. Some print screens might help.
You need to be in Package Explorer view for it to show when you right click. In Project Explorer it doesn't.
Then, when I click in the project and generate the documentation, it always gives "No documentation XML files generated ...", I have to click on the package containing the plugin for it to work.

The page on how to set up the open source eclipse is also a bit dated.
- Eclipse Classic distribution doesn't exist anymore
- The link to the "Sablo" project is missing from the list of Servoy projects needed
- Even if this is now ancient history, the page about the Servoy 5.2 still points to the SVN server that no longer exist

Maybe I picked some very specific examples, but I think this could be a bit more clear. There is some standard way to warn you about these glitches when I find them?

Re: Missing JavaDoc for Servoy API

PostPosted: Wed Aug 30, 2017 6:23 pm
by joe26