Javadoc cleanup #124
Merged
Javadoc cleanup #124
Conversation
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
caitlinrussell
commented
Feb 23, 2018
- 7bc879f: Add Javadoc where it was missing, mostly for @param and @return on buildRequest()
- 7c7b079: Add @param programmatically for action parameters
- 3cc433e: Replace invalid characters with HTML equivalent. We will need to do this later for .NET as well. The HTML is escaped in the XML metadata, but gets translated back to encoded characters during the template writing process.
added 3 commits
February 22, 2018 17:33
HTML characters get re-encoded into <,>,&, etc at this point, so we need to turn them back into HTML characters so that Javadoc accepts them as valid
MIchaelMainer
approved these changes
Feb 26, 2018
| public string ReplaceInvalidCharacters(string inputString) | ||
| { | ||
| if (inputString != null) { | ||
| return inputString.Replace("<", "<").Replace(">", ">").Replace("&", "&"); |
Collaborator
There was a problem hiding this comment.
Are '<', '>', and '&' the only characters we need to consider replacing?
Author
There was a problem hiding this comment.
I could not find a good document that outlined invalid characters that Javadoc doesn't like. Javadoc by default will convert the comments to valid HTML, so we don't need to worry about escaping quotes, slashes, etc.
I tested some common characters and didn't find anything that the compiler complained about:
@ { } % $ # [ ] | ^ ~ ; ? = : * \ " '
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.