[request] [Java] Improved javadoc

[Sylvestre Ledru]

*****Just for the record,
the Javadocs for Sikuli X-1.0 up to rc3 has been moved to http://doc.sikuli.org/javadoc/

the Javadocs of the new SikuliX-API-1.0:
https://dl.dropboxusercontent.com/u/42895525/SikuliX/SikuliX-API-JavaDocs/index.html

----------------------------------------------------------------------

Since I am using the Java API and I found the Javadoc a bit empty I wrote some javadoc comments.

If you are interested, I will write more patches in order to improve the Javadoc documentation.

[Tsung-Hsiang Chang (vgod)]

This's great. Thanks! We will apply this patch later.

Given we already have a great documentation (http://sikuli.org/docx/) written with Sphinx, we should sync the javadoc with the Sphinx doc somehow. However, we don't have a good solution to do that yet. Suggestions are welcome.
In the meantime, manually writing javadoc for some important classes and methods is a good idea.

[Sylvestre Ledru (sylvestre)]

Sorry, I don't have a perfect solution for this... but for now, having a good Javadoc is a nice solution (since, it is hard to get good doc on the Java Sikuli API) ;)

[Tsung-Hsiang Chang (vgod)]

Just for the record, the new Javadoc for Sikuli X has been moved to http://sikuli.org/doc/java-x/.