False javadoc warning for valid @snippet tags #1583#5190
Open
kamilkrzywanski wants to merge 1 commit into
Open
False javadoc warning for valid @snippet tags #1583#5190kamilkrzywanski wants to merge 1 commit into
kamilkrzywanski wants to merge 1 commit into
Conversation
When missingJavadocTagDescription=all_standard_tags, valid {@snippet}
tags incorrectly reported "Description expected after @snippet" because
pushSnippetText/pushExternalSnippetText set tagWaitingForDescription to
TAG_SNIPPET_VALUE instead of clearing it to NO_TAG_VALUE after content
was provided. Add regression tests covering valid, attributed, and empty
snippets.
Fixes eclipse-jdt#1583
Signed-off-by: Kamil Krzywannski <kamilkrzywanski01@gmail.com>
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
1 participant
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.
Summary
Javadoc: Description expected after @snippetwhenmissingJavadocTagDescription=all_standard_tags.pushSnippetText/pushExternalSnippetTextsettagWaitingForDescriptiontoTAG_SNIPPET_VALUEinstead of clearing it toNO_TAG_VALUEafter snippet content was provided (comment already said "clear the flag").JavadocTest_18for valid snippets, snippets with attributes, and empty snippets.Fixes #1583
Test plan
all_standard_tags){@snippet}still reports missing descriptionJavadocTest_18(52 tests, 0 failures) with the fix