Skip to content

Conversation

@guptapratykshh
Copy link

Issue: #17727

The default google_checks.xml configuration 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 the forbiddenSummaryFragments property in the SummaryJavadoc check 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.

@guptapratykshh guptapratykshh force-pushed the issue-17727-forbid-lowercase-javadoc branch 4 times, most recently from 7bd6369 to 9f416ee Compare December 4, 2025 06:07
@guptapratykshh guptapratykshh force-pushed the issue-17727-forbid-lowercase-javadoc branch from ba16b22 to 9b3c8ce Compare December 4, 2025 21:54
@guptapratykshh
Copy link
Author

@romani, Please look into this PR and review it. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant