zookeeper-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "TisonKun (JIRA)" <j...@apache.org>
Subject [jira] [Created] (ZOOKEEPER-3469) Enable checkEmptyJavadoc checkstyle rule
Date Fri, 26 Jul 2019 00:23:00 GMT
TisonKun created ZOOKEEPER-3469:

             Summary: Enable checkEmptyJavadoc checkstyle rule
                 Key: ZOOKEEPER-3469
                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-3469
             Project: ZooKeeper
          Issue Type: Improvement
          Components: build
            Reporter: TisonKun

While introducing BookKeeper checkstyle rules(see ZOOKEEPER-3431), we find it worth to have
a rule about javadocs of public classes. Specifically, check the javadocs of public class
not empty but valid.

However, providing valid javadocs for public classes those do not have one at the moment is
not a trivial work. Thus we file this issue to track another pass for doing so.

This message was sent by Atlassian JIRA

View raw message