[
https://issues.apache.org/jira/browse/FLINK-6107?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15986095#comment-15986095
]
Chesnay Schepler commented on FLINK-6107:
-----------------------------------------
The import statements were also frequently being messed with in PR's; adding
new entries that aren't in alphabetical order, reordering imports (like putting
java imports up top) or removing the separating empty lines.
Given that (i guess?) few people consider import statements as something
functional this was a good opportunity to use the same rules as another
well-established checkstyle.
I'm also not sure how well we could describe the existing scheme :/
> 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
> Fix For: 1.3.0
>
>
> 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)
