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

Ft conclude javadocs #29

Closed rodrigoalvesvieira closed 11 years ago

rodrigoalvesvieira commented 11 years ago

Hi everyone,

today was chosen for work on the documentation of Groundhog.

I did document almost all modules and classes in the project using Javadocs notation. I just did not document the br.ufpe.cin.groundhog.http module, because I understand very little of what it does. But the good news is that it is already partially documented.

Also, I can more clearly understand the code now that I took a full afternoon to browse and document the code. This experience was amazing I wish I could've done it earlier. In my opinion, the source code is not so big but nevertheless is easy to understand how its underpinnings work.

I've also edited and renamed the Overview Wiki page and that also helped me better understand how Groundhog works.

Please review this Pull Request and let me know if there's anything wrong with it or anything else that might prevent its merge with the master branch.

Thanks,

-- rodrigo

gustavopinto commented 11 years ago

Seems good! :+1:

Moreover, what do you think to add the copyright-license on top of each class? Something like this.

rodrigoalvesvieira commented 11 years ago

@gustavopinto yeah, seems good. But in each class?

gustavopinto commented 11 years ago

Yes. It may be in each class.