Repository navigation
Document missing parameters in HTTPUtilities Javadoc - #926
Open
VolodymyrLinuxovich wants to merge 1 commit into
Open
VolodymyrLinuxovich wants to merge 1 commit into
VolodymyrLinuxovich wants to merge 1 commit into
Conversation
Adds the missing @PARAM, @return and @throws tags and describes them from the reference implementation. Fixes the overloads that named the wrong current request or response, the sendRedirect doc that was copied from sendForward, the broken getSessionAttribute link, the self-closing <p/> tags and a few typos.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #783
This fills in the missing Javadoc in the HTTPUtilities interface. Most methods now have every @PARAM, @return and @throws documented. Only comments changed. I checked each description against DefaultHTTPUtilities.
Some of the old text did not match the code. A few overloads named the wrong object. addCookie(Cookie) and addHeader said the current request, but they use the response. getCookie(name) said the current response, but it reads the request. sendRedirect had the sendForward text copied word for word. It now says the location is checked with isValidRedirectLocation. addCookie, addHeader and setHeader log a warning and skip invalid input. They do not throw, so the docs now say that.
I also fixed a broken link to getSessionAttribute and a dead RFC link. The getFileUploads table had ".pn" where it should say ".png". There were a few typos too.
The pom sets doclint to none, so mvn javadoc:javadoc shows no warnings either way. Running javadoc with -Xdoclint:all on this file gave 97 warnings and 12 errors before. Now it gives 8 warnings and no errors. The 8 are on the interface constants, which I left alone.
One thing I did not change. The five argument setRememberToken in DefaultHTTPUtilities returns an empty string on success, not the token. The Javadoc now says what it does. I can fix the code in a separate PR if you want.