Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create code documentation with javadoc #20

Open
dnr2 opened this issue Apr 24, 2013 · 2 comments
Open

Create code documentation with javadoc #20

dnr2 opened this issue Apr 24, 2013 · 2 comments
Labels
continuous documentation

Comments

@dnr2
Copy link
Member

dnr2 commented Apr 24, 2013

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.
dnr2 pushed a commit that referenced this issue Apr 26, 2013
added javadoc to methods and solved the CSVWriter closing twice probl…
a0c7cf7 
…em. Related to #10 and #20
rodrigoalvesvieira pushed a commit that referenced this issue Apr 27, 2013
Adding missing documentation for some methods, fixing typos and remov…
6e078ca 
…ing unnecessary blank spaces/lines. Related to #6 and #20.
rodrigoalvesvieira pushed a commit that referenced this issue Apr 27, 2013
Adding more missing documentation. Related to #20.
15b0498
gustavopinto pushed a commit that referenced this issue Apr 28, 2013
updating scmclient package to use guice. related to #8, #20
dfe6ee3
rodrigoalvesvieira pushed a commit that referenced this issue May 2, 2013
Working on the documentation. Related to #20
3876eb4
rodrigoalvesvieira pushed a commit that referenced this issue May 2, 2013
Working on the documentation. Related to #20
f7479b3
rodrigoalvesvieira pushed a commit that referenced this issue May 3, 2013
Working on the documentation for the extracor package files. Related to
b44a402 
#20.
rodrigoalvesvieira pushed a commit that referenced this issue May 3, 2013
Improving documentation of the SearchGitHub class and working on fetc…
1b47cf6 
…hing more interesting data from the Google Code forge. Successfully could grab one more property: watchers count. Related to #20 and #14.
rodrigoalvesvieira pushed a commit that referenced this issue May 3, 2013
Improving documentation. Related to #20. Closes #14.
a98844d
rodrigoalvesvieira pushed a commit that referenced this issue May 4, 2013
Partially commenting methods and removing hard-coded date string. Rel…
3c4e798 
…ated to #6 and #20.
rodrigoalvesvieira pushed a commit that referenced this issue May 4, 2013
Finishing writing Javadocs for the br.ufpe.cin.groundhog.main package…
e0a4485 
…. Related to #20.
rodrigoalvesvieira pushed a commit that referenced this issue May 4, 2013
Finishing writing Javadocs for the br.ufpe.cin.groundhog package. Rel…
b7d2deb 
…ated to #20.
rodrigoalvesvieira pushed a commit that referenced this issue May 4, 2013
Finishing writing Javadocs for the br.ufpe.cin.groundhog.codehistory …
d11006a 
…package. Related to #20.
rodrigoalvesvieira pushed a commit that referenced this issue May 4, 2013
Small tweaks in the br.ufpe.cin.groundhog.extractor module. Related to …
87159c5 
…#20.
rodrigoalvesvieira pushed a commit that referenced this issue May 4, 2013
Adding documentation to the br.ufpe.cin.groundhog.http package and ad…
35729c5 
…ding 'this' to the references to local object's properties. Related to #6 and #20.
rodrigoalvesvieira pushed a commit that referenced this issue May 4, 2013
Finishing writing Javadocs for the br.ufpe.cin.groundhog.scmclient pa…
c393f93 
…ckage. Related to #20.
rodrigoalvesvieira pushed a commit that referenced this issue May 4, 2013
Finishing writing Javadocs for the br.ufpe.cin.groundhog.search packa…
fb4b115 
…ge. Related to #20.
@marlonwc3
Copy link
Contributor

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.

@marlonwc3 marlonwc3 reopened this Feb 19, 2014
@rodrigoalvesvieira
Copy link
Contributor

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

marlonwc3 referenced this issue Feb 19, 2014
@marlonwc3
Project test and annotations(documentations).
a2ae7f6 
Created more tests that protect all behaviors expected in GitHub
Entities pre-defined by other Groundhog contributor which maybe can be
affected by some code change in basic classes.
Improved Project anotation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
continuous documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rodrigoalvesvieira @dnr2 @marlonwc3