Issue #17727: Add regex pattern to forbid lowercase Javadoc beginnins in google_checks.xml #18241
+930
−926
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.