[ZOOKEEPER-3469] Checkstyle rules for ensure proper javadocs

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: build
• Assignee: Unassigned
• Reporter: Zili Chen
• Created: 26/Jul/19 00:22
• Updated: 10/Aug/19 02:15

Description

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.

Issue Links

• relates to: ZOOKEEPER-3431 Enable BookKeeper checkstyle configuration