Upstream/Multiverse-Core
1
0
Fork 0
mirror of https://github.com/Multiverse/Multiverse-Core.git synced 2024-11-21 18:15:26 +01:00
Code Issues Projects Releases Wiki Activity

Configure Javadoc checkstyle.

Browse Source
This commit is contained in:
Jeremy Wood 2023-09-06 01:05:13 -04:00
parent e04b0faa85
commit ab2dd9d316
No known key found for this signature in database
GPG Key ID: C5BAD04C77B91B4B
1 changed files with 36 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
config/mv_checks.xml
View File

@ -15,9 +15,7 @@
<property name="max" value="160"/> <property name="max" value="160"/>
<property name="severity" value="warning"/> <property name="severity" value="warning"/>
</module> </module>
<module name="JavadocPackage"> <module name="JavadocPackage"/><!-- require package-info.java file -->
<property name="allowLegacy" value="true"/>
</module>
<module name="NewlineAtEndOfFile" /> <module name="NewlineAtEndOfFile" />
<module name="Translation"/> <module name="Translation"/>
<module name="FileLength"/> <module name="FileLength"/>
@ -43,16 +41,47 @@
<property name="offCommentFormat" value="BEGIN CHECKSTYLE-SUPPRESSION\: ALL"/> <property name="offCommentFormat" value="BEGIN CHECKSTYLE-SUPPRESSION\: ALL"/>
<property name="onCommentFormat" value="END CHECKSTYLE-SUPPRESSION\: ALL"/> <property name="onCommentFormat" value="END CHECKSTYLE-SUPPRESSION\: ALL"/>
</module> </module>
<!-- Actual checks --> <!-- Actual checks -->
<module name="AtclauseOrder"/>
<module name="InvalidJavadocPosition"/>
<module name="JavadocBlockTagLocation"/>
<module name="JavadocContentLocationCheck"/>
<module name="JavadocMethod"> <module name="JavadocMethod">
<property name="accessModifiers" value="public, protected, package"/><!-- We don't need javadoc for private methods --> <property name="accessModifiers" value="public, protected, package"/>
<property name="tokens" value="METHOD_DEF"/><!-- We don't need javadoc for constructors --> <property name="tokens" value="METHOD_DEF"/>
</module> </module>
<module name="JavadocMethod">
<property name="accessModifiers" value="public"/>
</module>
<module name="JavadocMissingLeadingAsterisk"/>
<module name="JavadocMissingWhitespaceAfterAsterisk"/>
<module name="JavadocParagraph">
<property name="allowNewlineParagraph" value="true"/>
</module>
<module name="JavadocStyle">
<property name="scope" value="package"/>
</module>
<module name="JavadocTagContinuationIndentation"/>
<module name="JavadocType"/> <module name="JavadocType"/>
<module name="JavadocVariable"> <module name="JavadocVariable">
<property name="scope" value="package"/><!-- We don't need javadoc for private variables --> <property name="scope" value="package"/>
</module> </module>
<module name="JavadocStyle"/> <module name="MissingJavadocMethod">
<property name="scope" value="public"/>
<property name="allowMissingPropertyJavadoc" value="true"/>
</module>
<module name="MissingJavadocMethod">
<property name="scope" value="protected"/>
<property name="excludeScope" value="public"/>
<property name="allowMissingPropertyJavadoc" value="true"/>
<property name="minLineCount" value="2"/>
</module>
<module name="MissingJavadocType"/>
<module name="NonEmptyAtclauseDescription"/>
<module name="RequireEmptyLineBeforeBlockTagGroup"/>
<module name="SingleLineJavadoc"/>
<module name="SummaryJavadoc"/>
<module name="WriteTag"> <module name="WriteTag">
<property name="tag" value="@author"/> <property name="tag" value="@author"/>
<property name="tagFormat" value="\S"/> <property name="tagFormat" value="\S"/>