[
https://issues.apache.org/jira/browse/CALCITE-4137?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17165472#comment-17165472
]
Vladimir Sitnikov commented on CALCITE-4137:
--------------------------------------------
Javadoc would produce warnings as follows:
{noformat}
/home/runner/work/calcite/calcite/core/src/main/java/org/apache/calcite/sql/SqlOperator.java:745:
warning: no @param for opNameToUse
public String getAllowedSignatures(String opNameToUse) {
^
/home/runner/work/calcite/calcite/core/src/main/java/org/apache/calcite/sql/SqlOperator.java:745:
warning: no @return
public String getAllowedSignatures(String opNameToUse) {
^
{noformat}
Frankly speaking, I think they do clutter the logs and make it harder to
analyze CI results :-/
> 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)
