[
https://issues.apache.org/jira/browse/CALCITE-4137?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17165079#comment-17165079
]
Julian Hyde commented on CALCITE-4137:
--------------------------------------
Sure, Checkstyle is not the best tool in the world. But there are PRs being
committed where some classes are missing javadoc. That is pretty basic. This
change will stop this. Good coders will never see those "unreadable error
messages", because they'll always add Javadoc, right?
{quote}I guess this already produces Javadoc warnings, doesn't it?
{quote}
No, the Javadoc warnings are for missing {{@param}} annotations, which frankly
does not concern me. I do have a problem with someone writing {{@param p}} or
{{@returns}} with no description, and the new check will find that.
> 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)
