zookeeper-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "TisonKun (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (ZOOKEEPER-3469) Checkstyle rules for ensure proper javadocs
Date Sat, 10 Aug 2019 02:16:00 GMT

     [ https://issues.apache.org/jira/browse/ZOOKEEPER-3469?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel

TisonKun updated ZOOKEEPER-3469:
    Summary: Checkstyle rules for ensure proper javadocs  (was: Enable checkEmptyJavadoc checkstyle

> Checkstyle rules for ensure proper javadocs
> -------------------------------------------
>                 Key: ZOOKEEPER-3469
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-3469
>             Project: ZooKeeper
>          Issue Type: Improvement
>          Components: build
>            Reporter: TisonKun
>            Priority: Major
> 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