Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » scout » Javadoc / Eclipse help
Javadoc / Eclipse help [message #749219] Tue, 25 October 2011 01:05 Go to next message
Boy D'Poy is currently offline Boy D'Poy
Messages: 56
Registered: October 2011
Member
Hi!

The project is declared stable and production-ready, but it's hard to find a suitable documentation.

Unlike other Eclipse's plugins, a F1 hit brings nothing.

We have a variety of components well undocumented.

Is it possible to have at least the Javadoc / Eclipse help?


Once You Go Scout, You Never Come Out!
Re: Javadoc / Eclipse help [message #753289 is a reply to message #749219] Wed, 26 October 2011 13:57 Go to previous messageGo to next message
Matthias Zimmermann is currently offline Matthias Zimmermann
Messages: 79
Registered: February 2010
Member
hi

yes, we know that documentation is not our strength currently. but, we are working continuously on getting a more comprehensive documentation of eclipse scout step-by-step. our current focus is on the scout wiki, such as adding elements into scout tutorials, the scout documentation, or the how-to pieces.

so far, eclipse help was not our top priority. but we're open to suggestions. what we don't want is to violate the dry principle[1]: there should be a single central place for the documentation that is easily accessible and easy to update.

regarding javadoc: most of our public interfaces have their respective javadoc. but of cource, this task is not completed yet.

should you have any specific needs or have a specific problem, please let us know in your reply, and we will try to help. such input helps us to prioritize our efforts.

thanks
matthias

[1] dry = don't repeat yourself
Re: Javadoc / Eclipse help [message #753439 is a reply to message #753289] Thu, 27 October 2011 05:26 Go to previous messageGo to next message
Boy D'Poy is currently offline Boy D'Poy
Messages: 56
Registered: October 2011
Member
That's OK for me!

Once You Go Scout, You Never Come Out!
Re: Javadoc / Eclipse help [message #753442 is a reply to message #753289] Thu, 27 October 2011 05:30 Go to previous message
Jeremie Bresson is currently offline Jeremie Bresson
Messages: 649
Registered: October 2011
Senior Member
We should have a look at this crowd sourcing example.

Using WikiText and the MediaWiki API/export, it should be possible to convert the wikipages we have into an offline downloadable html content and an eclipse-help project (See this example on GitHub)

Any idea how we should start?

Previous Topic:Remove unused translations ?
Next Topic:Process Service and Templates
Goto Forum:
  


Current Time: Thu Jul 31 13:46:11 EDT 2014

Powered by FUDForum. Page generated in 0.07389 seconds