Ticket #23465: 23465.patch

File 23465.patch, 5.0 KB (added by taylor.smock, 2 years ago)

Replace custom Javadoc check with upstream check

  • deleted file tools/checkstyle/src/org/openstreetmap/josm/TopLevelJavadocCheck.java 

    Subject: [PATCH] See #23465: Replace custom check with upstream check
---
diff --git a/tools/checkstyle/src/org/openstreetmap/josm/TopLevelJavadocCheck.java b/tools/checkstyle/src/org/openstreetmap/josm/TopLevelJavadocCheck.java
deleted file mode 100644
    + -  
    1 // License: GPL. For details, see LICENSE file.
    2 package org.openstreetmap.josm;
    3 
    4 import com.puppycrawl.tools.checkstyle.JavadocDetailNodeParser;
    5 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
    6 import com.puppycrawl.tools.checkstyle.api.DetailAST;
    7 import com.puppycrawl.tools.checkstyle.api.DetailNode;
    8 import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes;
    9 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
    10 import com.puppycrawl.tools.checkstyle.utils.JavadocUtil;
    11 
    12 /**
    13  * Checks that there is Javadoc for every top level class, interface or enum.
    14  */
    15 public class TopLevelJavadocCheck extends AbstractCheck {
    16 
    17     private boolean foundTopLevelClass;
    18 
    19     @Override
    20     public int[] getAcceptableTokens() {
    21         return getDefaultTokens();
    22     }
    23 
    24     @Override
    25     public int[] getDefaultTokens() {
    26         return new int[]{TokenTypes.CLASS_DEF, TokenTypes.INTERFACE_DEF, TokenTypes.ENUM_DEF};
    27     }
    28 
    29     @Override
    30     public int[] getRequiredTokens() {
    31         return new int[0];
    32     }
    33 
    34     @Override
    35     public boolean isCommentNodesRequired() {
    36         return true;
    37     }
    38 
    39     @Override
    40     public void beginTree(DetailAST rootAST) {
    41         foundTopLevelClass = false;
    42     }
    43 
    44     @Override
    45     public void finishTree(DetailAST rootAST) {
    46         if (!foundTopLevelClass) {
    47             this.log(rootAST.getLineNo(), "assertion failure: unable to find toplevel class or interface");
    48         }
    49     }
    50 
    51     private boolean hasJavadoc(DetailAST ast) {
    52         DetailAST blockCommentBegin = ast.findFirstToken(TokenTypes.BLOCK_COMMENT_BEGIN);
    53         if (blockCommentBegin == null) {
    54             DetailAST modifiers = ast.findFirstToken(TokenTypes.MODIFIERS);
    55             if (modifiers == null)
    56                 return false;
    57             blockCommentBegin = modifiers.findFirstToken(TokenTypes.BLOCK_COMMENT_BEGIN);
    58             if (blockCommentBegin == null) {
    59                 DetailAST annotation = modifiers.findFirstToken(TokenTypes.ANNOTATION);
    60                 if (annotation == null)
    61                     return false;
    62                 blockCommentBegin = annotation.findFirstToken(TokenTypes.BLOCK_COMMENT_BEGIN);
    63                 if (blockCommentBegin == null)
    64                     return false;
    65             }
    66         }
    67         if (!JavadocUtil.isJavadocComment(blockCommentBegin))
    68             return false;
    69         DetailNode javadocTree = new JavadocDetailNodeParser().parseJavadocAsDetailNode(blockCommentBegin).getTree();
    70         return hasProperText(javadocTree);
    71     }
    72 
    73     private boolean hasProperText(DetailNode javadoc) {
    74         if (javadoc == null) return false;
    75         for (DetailNode child : javadoc.getChildren()) {
    76             if (child.getType() == JavadocTokenTypes.TEXT) {
    77                 if (!child.getText().trim().isEmpty())
    78                     return true;
    79             } else if (child.getType() == JavadocTokenTypes.HTML_ELEMENT) {
    80                 return true;
    81             }
    82         }
    83         return false;
    84     }
    85 
    86     @Override
    87     public void visitToken(DetailAST ast) {
    88         DetailAST parent = ast.getParent();
    89         if (parent == null || parent.getType() == TokenTypes.COMPILATION_UNIT) {
    90             foundTopLevelClass = true;
    91             if (!hasJavadoc(ast)) {
    92                 this.log(ast.getLineNo(), "incomplete or missing Javadoc for top level class or interface");
    93             }
    94         }
    95    }
    96 }

  • tools/checkstyle/josm_checks.xml 

    IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
diff --git a/tools/checkstyle/josm_checks.xml b/tools/checkstyle/josm_checks.xml
    a b  
    3131      <property name="checkFirstSentence" value="false"/>
    3232      <property name="checkHtml" value="false"/>
    3333    </module>
     34    <module name="MissingJavadocType"/>
    3435    <module name="NonEmptyAtclauseDescription"/>
    3536    <module name="AtclauseOrder"/>
    3637    <module name="AvoidStarImport"/>
    … …  
    9596    <module name="OuterTypeFilename"/>
    9697    <module name="FinalClass"/>
    9798    <module name="HideUtilityClassConstructor"/>
    98     <module name="org.openstreetmap.josm.TopLevelJavadocCheck"/>
    9999    <module name="SuppressionCommentFilter">
    100100      <property name="offCommentFormat" value="CHECKSTYLE\.OFF\: ([\w\|]+)"/>
    101101      <property name="onCommentFormat" value="CHECKSTYLE\.ON\: ([\w\|]+)"/>