Details

    • Type: Sub-task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.3.0
    • Component/s: DataStream API
    • Labels:
      None

      Description

      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:

      <!--
      
      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>
      

      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

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                aljoscha Aljoscha Krettek
                Reporter:
                aljoscha Aljoscha Krettek
              • Votes:
                0 Vote for this issue
                Watchers:
                6 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: