Issue #17727: Add regex pattern to forbid lowercase Javadoc beginnins in google_checks.xml #18241
+930
−926
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
guptapratykshh
force-pushed
the
issue-17727-forbid-lowercase-javadoc
branch
5 times, most recently
from
ba16b22 to
9b3c8ce
Compare
Author
|
@romani, Please look into this PR and review it. Thanks |
Author
|
ping @romani |
romani
requested changes
Dec 10, 2025
Member
romani
left a comment
romani
left a comment
There was a problem hiding this comment.
thanks a lot !!!
tiny update to make it perfect:
src/main/resources/google_checks.xml
Outdated
| <module name="SummaryJavadoc"> | ||
| <property name="forbiddenSummaryFragments" | ||
| value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/> | ||
| value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )|^[a-z]"/> |
Member
There was a problem hiding this comment.
please make indentation of attribute to be +2 from tag, you have space.
Member
|
@Zopsss , please help to review this PR, I have only minor request. I am good to merge this as soon as it is fixed. |
guptapratykshh
force-pushed
the
issue-17727-forbid-lowercase-javadoc
branch
from
9b3c8ce to
bc5b36e
Compare
… beginnings in google_checks.xml
guptapratykshh
force-pushed
the
issue-17727-forbid-lowercase-javadoc
branch
from
bc5b36e to
2b78155
Compare
Member
|
Please rebase to most latest code , CI is red as reminder to you. Please follow. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Issue: #17727
The default
google_checks.xmlconfiguration does not enforce the Google Style Guide rule that Javadoc summary fragments must start with a capital letter. This leads to false negatives where Javadoc summaries beginning with lowercase letters (for example, "adds an element to the list.") are not marked as violations, even though the Google Style Guide states that summaries should be "capitalized and punctuated as if it were a complete sentence."I added the regex pattern
|^\s*[a-z]to theforbiddenSummaryFragmentsproperty in theSummaryJavadoccheck configuration. This pattern detects Javadoc summaries that start with optional whitespace followed by a lowercase letter, ensuring that lowercase beginnings in Javadoc are marked as violations according to the Google Style Guide.