search

gintool / gin

GI in No Time - a Simple Microframework for Genetic Improvement
MIT License
43 stars 20 forks source link

Standardise and improve Javadoc #39

Open GiovaniGuizzo opened 4 years ago

GiovaniGuizzo commented 4 years ago

The current Javadoc is not complete. I have already improved and am still improving the Javadoc of some of the classes. For example: CacheClassLoader.

My suggestion is to improve and standardise the Javadoc while modifying a class, rather than improving the Javadoc of the whole prohect in one go (too boring).

If you are willing to add Javadoc, here is a link to best practices of documentation: Oracle's Guide.

sandybrownlee commented 4 years ago

Thanks Giovani - your contributions are very much appreciated! The team are a little swamped with work getting a paper on Gin finished but we hope to get to your PRs soon (probably a few weeks though).