Files

32 lines
1.5 KiB
XML

<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
<!--Single Suppression Filters-->
<module name="io.papermc.checkstyle.filters.BetterSuppressionSingleFilter">
<property name="checks" value="Javadoc(Method|Type)"/>
<property name="messageKey" value="javadoc\.unknownTag"/>
<!--[A-Z].* check is for java annotations inside code blocks inside Javadocs-->
<property name="arguments" value="(${custom_javadoc_tags}|[A-Z].*)"/>
</module>
<module name="TreeWalker">
<!--Skip generated content by typewriter-->
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="Start generate - \w+$"/>
<property name="onCommentFormat" value="End generate - \w+$"/>
</module>
<module name="JavadocVariable">
<!--requires on public fields-->
<property name="accessModifiers" value="public"/>
</module>
<module name="MissingJavadocMethod">
<property name="allowedAnnotations" value="Override, ApiStatus.Internal"/>
<property name="ignoreMethodNamesRegex" value="^getHandlerList$"/>
</module>
<module name="MissingJavadocPackage"/>
<module name="MissingJavadocType">
<property name="skipAnnotations" value="Generated, ApiStatus.Internal"/>
</module>
</module>
</module>