search

spgroup / groundhog

A framework for crawling GitHub projects and raw data and to extract metrics from them
http://spgroup.github.io/groundhog
GNU General Public License v2.0
15 stars 10 forks source link

Create code documentation with javadoc #20

Open dnr2 opened 11 years ago

dnr2 commented 11 years ago

For better understanding, the code should be commented using javadoc which will give the developers an overall explanation of the most important methods and modules.

marlonwc3 commented 10 years ago

This issue doesn't should be opened like a continuos Issue? Talking about "Issue", this Groundhog entity has a bad doc that can be improved, i will do this Job these days. To a good project pattern (and remembering this is a open source project where sometimes Contributtors doesn't have communication), i think it's a good idea build strong documentations that can be used to save the time of others contributors and leave the code clean.

rodrigoalvesvieira commented 10 years ago

Yes, thanks @marlonwc3. It is a continuous issue.