Mailing-List: contact issues-help@flink.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@flink.apache.org
Date: Sat, 18 Mar 2017 06:59:41 +0000 (UTC)
From: "Aljoscha Krettek (JIRA)" <jira@apache.org>
To: issues@flink.apache.org
Message-ID: <JIRA.13057231.1489820335000.56106.1489820381560@Atlassian.JIRA>
In-Reply-To: <JIRA.13057231.1489820335000@Atlassian.JIRA>
References: <JIRA.13057231.1489820335000@Atlassian.JIRA> <JIRA.13057231.1489820335764@jira-lw-us.apache.org>
Subject: [jira] [Created] (FLINK-6107) Add custom checkstyle for
 flink-streaming-java
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
archived-at: Sat, 18 Mar 2017 06:59:46 -0000

Aljoscha Krettek created FLINK-6107:
---------------------------------------

             Summary: Add custom checkstyle for flink-streaming-java
                 Key: FLINK-6107
                 URL: https://issues.apache.org/jira/browse/FLINK-6107
             Project: Flink
          Issue Type: Improvement
          Components: DataStream API
            Reporter: Aljoscha Krettek
            Assignee: Aljoscha Krettek


There was some consensus on the ML (https://lists.apache.org/thread.html/94c8c5186b315c58c3f8aaf536501b99e8b92ee97b0034dee295ff6a@%3Cdev.flink.apache.org%3E) that we want to have a more uniform code style. We should start module-by-module and by introducing increasingly stricter rules. We have to be aware of the PR situation and ensure that we have minimal breakage for contributors.

This issue aims at adding a custom checkstyle.xml for {{flink-streaming-java}} that is based on our current checkstyle.xml but adds these checks for Javadocs:
{code}
<!--

JAVADOC CHECKS

-->

<!-- Checks for Javadoc comments.                     -->
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
<module name="JavadocMethod">
  <property name="scope" value="protected"/>
  <property name="severity" value="error"/>
  <property name="allowMissingJavadoc" value="true"/>
  <property name="allowMissingParamTags" value="true"/>
  <property name="allowMissingReturnTag" value="true"/>
  <property name="allowMissingThrowsTags" value="true"/>
  <property name="allowThrowsTagsForSubclasses" value="true"/>
  <property name="allowUndeclaredRTE" value="true"/>
</module>

<!-- Check that paragraph tags are used correctly in Javadoc. -->
<module name="JavadocParagraph"/>

<module name="JavadocType">
  <property name="scope" value="protected"/>
  <property name="severity" value="error"/>
  <property name="allowMissingParamTags" value="true"/>
</module>

<module name="JavadocStyle">
  <property name="severity" value="error"/>
  <property name="checkHtml" value="true"/>
</module>
{code}

This checks:
 - Every type has a type-level Javadoc
 - Proper use of {{<p>}} in Javadocs
 - First sentence must end with a proper punctuation mark
 - Proper use (including closing) of HTML tags


--
This message was sent by Atlassian JIRA
(v6.3.15#6346)