Skip to content

Commit

Permalink
Fix #23465: Remove custom checkstyle plugin
Browse files Browse the repository at this point in the history
TopLevelJavadocCheck.java is duplicating functionality from MissingJavadocType.
Our custom class is from #14794 (closed 2017-10-16). The check that makes it
redundant was added in checkstyle 8.20 (released 2019-04-28).

This adds the missing javadocs for the more comprehensive checkstyle version.

git-svn-id: https://josm.openstreetmap.de/osmsvn/applications/editors/josm/plugins@36208 b9d5c4c9-76e1-0310-9c85-f3177eceb1e4
  • Loading branch information
tsmock committed Feb 12, 2024
1 parent e932944 commit caf7c90
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 13 deletions.
13 changes: 1 addition & 12 deletions build-common.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
<property name="josm.ivysettings" location="../../core/ivysettings.xml"/>
<property name="josm.test.build.dir" location="../../core/test/build"/>
<property name="jmockit.jar" location="../00_core_test_lib/jmockit.jar"/>
<property name="checkstyle-build.dir" location="../00_core_tools/checkstyle/build"/>
<property name="annotations.jar" location="../00_core_tools/spotbugs/spotbugs-annotations.jar"/>
<property name="core.tools.ivy" location="../00_core_tools/ivy.xml"/>
<property name="plugin.tools.dir" location="../00_tools"/>
Expand Down Expand Up @@ -410,7 +409,6 @@
<target name="clean">
<delete dir="${plugin.build.dir}"/>
<delete dir="${plugin.doc.dir}"/>
<delete dir="${checkstyle-build.dir}"/>
<delete file="${plugin.jar}"/>
<delete file="${plugin.sources.jar}"/>
<delete file="${plugin.javadoc.jar}"/>
Expand Down Expand Up @@ -647,18 +645,9 @@
</sequential>
</target>

<target name="checkstyle-compile" depends="resolve-tools">
<mkdir dir="${checkstyle-build.dir}"/>
<javac sourcepath="" srcdir="../00_core_tools/checkstyle/src" failonerror="true"
destdir="${checkstyle-build.dir}" release="${java.lang.version}" debug="on"
includeantruntime="false" createMissingPackageInfoClass="false"
encoding="UTF-8" classpathref="checkstyle.classpath">
</javac>
</target>
<target name="checkstyle" depends="checkstyle-compile">
<target name="checkstyle" depends="resolve-tools">
<taskdef resource="com/puppycrawl/tools/checkstyle/ant/checkstyle-ant-task.properties">
<classpath refid="checkstyle.classpath"/>
<classpath path="${checkstyle-build.dir}"/>
</taskdef>
<checkstyle config="${basedir}/../checkstyle-config.xml">
<fileset dir="${basedir}/src" includes="**/*.java" excludes="boofcv/**/*.java,
Expand Down
2 changes: 1 addition & 1 deletion checkstyle-config.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ JOSM Checkstyle rules
<property name="checkFirstSentence" value="false"/>
<property name="checkHtml" value="false"/>
</module>
<module name="MissingJavadocType"/>
<module name="NonEmptyAtclauseDescription"/>
<module name="AtclauseOrder"/>
<module name="AvoidStarImport"/>
Expand Down Expand Up @@ -95,7 +96,6 @@ JOSM Checkstyle rules
<module name="OuterTypeFilename"/>
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<module name="org.openstreetmap.josm.TopLevelJavadocCheck"/>
<module name="SuppressionCommentFilter">
<property name="offCommentFormat" value="CHECKSTYLE\.OFF\: ([\w\|]+)"/>
<property name="onCommentFormat" value="CHECKSTYLE\.ON\: ([\w\|]+)"/>
Expand Down

0 comments on commit caf7c90

Please sign in to comment.