(Eclipse formatter) Do not format html in Javadoc #305
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
Make eclipse formatter comply with section '7.1.2 Paragraphs' by keeping the first word in the paragraph immediately following the paragraph tag. Normally, Eclipse would insert a newline in the javadoc, and begin the paragraph on the next line. That's because surrounding whitespace should not matter for HTML block level elements like the paragraph tag, and this improves readability of the Javadoc source. However, the Google StyleGuide for Java forbids this extra newline in section 7.1.2. The only way to have Eclipse respect this is by disabling html formatting entirely.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Make eclipse formatter comply with section '7.1.2 Paragraphs' by keeping
the first word in the paragraph immediately following the paragraph tag.
Normally, Eclipse would insert a newline in the javadoc, and begin the
paragraph on the next line. That's because surrounding whitespace should
not matter for HTML block level elements like the paragraph tag, and
this improves readability of the Javadoc source. However, the Google
StyleGuide for Java forbids this extra newline in section 7.1.2. The
only way to have Eclipse respect this is by disabling html formatting
entirely.