[
https://issues.apache.org/jira/browse/CALCITE-4137?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17165081#comment-17165081
]
Vladimir Sitnikov edited comment on CALCITE-4137 at 7/25/20, 5:41 PM:
----------------------------------------------------------------------
Oh, I was recently bitten by a complicated Checkstyle configuration:
https://github.com/adobe/S3Mock/pull/231. I dit try committing multiple PR
variations, and then I gave up :-(
It was extremely hard to understand what was wrong there.
It seems to be reasonable to require Javadoc at the class level for the public
classes. Do you mean to include test classes as well? Do you intend to require
Javadoc for package-private and private classes?
was (Author: vladimirsitnikov):
Oh, I was recently bitten by a complicated Checkstyle configuration:
https://github.com/adobe/S3Mock/pull/231. I dit try committing multiple PR
variations, and then I gave up :-(
It was extremely hard to understand what is wrong there.
It seems to be reasonable to require Javadoc at the class level for the public
classes. Do you mean to include test classes as well? Do you intend to require
Javadoc for package-private and private classes?
> Checkstyle should ensure that every class has a Javadoc comment
> ---------------------------------------------------------------
>
> Key: CALCITE-4137
> URL: https://issues.apache.org/jira/browse/CALCITE-4137
> Project: Calcite
> Issue Type: Bug
> Reporter: Julian Hyde
> Assignee: Julian Hyde
> Priority: Major
> Fix For: 1.25.0
>
>
> Checkstyle should ensure that every class, interface, enum, package has a
> Javadoc comment. And that javadoc types (e.g {{@param}} and {{@return}}) are
> not empty.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
