Skip to content

Fix javadoc warnings #36

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.

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

Closed
wants to merge 1 commit into from
Closed

Fix javadoc warnings #36

wants to merge 1 commit into from

Conversation

sslavic
Copy link
Contributor

@sslavic sslavic commented Feb 12, 2012

Before this fix there were numerous javadoc warnings being reported
while building Spring framework API.

This fix resolves most of the javadoc warnings.

Issue: SPR-9113

I have signed and agree to the terms of SpringSource Individual Contributor License Agreement.

@sslavic
Copy link
Contributor Author

sslavic commented Mar 1, 2012

@cbeams I will change title and description of this pull request, rebase it to latest master and also align javadoc changes with your comment.

Since pull request contains lots of changes (all only for numerous warnings reported when building api), would it be easier for validation and accepting the pull request to split it somehow or is single pull request with everything OK?

Would be great if pull request 35 was accepted first. Have to adjust pull request description there.

@cbeams
Copy link
Contributor

cbeams commented Mar 1, 2012

A single pull request is ok, as long as individual commits in the PR represent distinct atomic changes.

I can merge #35 first, that's fine. Rebase them if you like, but if I don't get to merging it right away, I'll rebase it again locally before committing anyway.

Before this fix there were numerous javadoc warnings being reported
while building Spring framework API.

This fix resolves most of the javadoc warnings.

Issue: SPR-9113
@ghost ghost assigned cbeams Apr 30, 2012
cbeams added a commit that referenced this pull request Apr 30, 2012
* SPR-9113:
  Fix javadoc warnings
@cbeams
Copy link
Contributor

cbeams commented Apr 30, 2012

This is merged, thanks Stevo. Please note however that a couple modifications were necessary:

  • a number of the changed lines had trailing whitespace. This is probably an artifact of your editor. Consider making whitespace visible while editing ("Show Whitespace Characters" in Eclipse); or just examine carefully the output of git diff before pushing commits. If you have color diffs enabled, you'll see trailing whitespace in red.
  • Apache copyright headers were not updated in most files, i.e. 2002-2011 being updated to 2002-2012.

Both of the above are covered in the contributor guidelines.

This is a big improvement; it reduced the number of javadoc warnings from 265 to 103. Thanks again!

@cbeams cbeams closed this Apr 30, 2012
rwinch pushed a commit to rwinch/spring-framework that referenced this pull request Jun 20, 2016
rwinch pushed a commit to rwinch/spring-framework that referenced this pull request Jul 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants