Repository navigation
InvalidSnippet: don't flag external snippets that use the class attribute - #6248
Open
joselynrianaaa wants to merge 1 commit into
Open
joselynrianaaa wants to merge 1 commit into
joselynrianaaa wants to merge 1 commit into
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
joselynrianaaa
force-pushed
the
fix-invalidsnippet-external-snippets
branch
from
October 27, 2026 23:46
e2a8745 to
283721f
Compare
This branch has not been deployed
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.
Fixes #6238
InvalidSnippetreported "This @snippet has no body" for external snippets thatreference their content with the
classattribute, for example:Per the JavaDoc specification, the colon, newline and body may be omitted in an
external snippet, which is one that uses either
fileorclass:https://docs.oracle.com/en/java/javase/25/docs/specs/javadoc/doc-comment-spec.html#external-snippets
The check already exempted snippets with a
fileattribute but notclass. Thischange exempts both. A snippet that has no body and neither attribute is still
reported.
Tests added to
InvalidSnippetTest:snippetWithoutBody_butWithClass: the case from the issue.snippetWithoutBody_butWithClassAndTrailingSpace:{@snippet class=HelloWorld },the form used in the JDK programmer's guide.
snippetWithoutBody_andWithoutFileOrClass: confirms the warning still fires whenthere is no body and no external reference.