Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rule: KDoc's first sentence should have a proper end #699

Closed
egor-n opened this issue Jan 18, 2018 · 2 comments
Closed

Rule: KDoc's first sentence should have a proper end #699

egor-n opened this issue Jan 18, 2018 · 2 comments

Comments

@egor-n
Copy link
Contributor

egor-n commented Jan 18, 2018

Checkstyle's JavadocStyle for reference – http://checkstyle.sourceforge.net/config_javadoc.html#JavadocStyle.

KDoc's first sentence should have a proper end. The "proper end" can be defined with a regular expression. Looks like checkstyle uses ([.?!][ \t\n\r\f<])\|([.?!]$).

Would also be nice to check if the first sentence starts with a capital letter.

@vanniktech
Copy link
Contributor

Yes. I like this. I also have this implemented with Lint.

@lock
Copy link

lock bot commented Jun 20, 2019

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related topics.

@lock lock bot locked as resolved and limited conversation to collaborators Jun 20, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants