Changeset 18974 in josm for trunk/test/unit

Timestamp:

2024-02-12T23:00:59+01:00 (12 months ago)

Author:

taylor.smock

Message:

Fix #23465: Remove custom checkstyle plugin

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.

Location:

trunk/test/unit/org/openstreetmap/josm/testutils

Files:

• PluginServer.java (modified) (2 diffs)
• annotations/ResetUniquePrimitiveIdCounters.java (modified) (1 diff)
• annotations/TaggingPresets.java (modified) (1 diff)
• annotations/TestUser.java (modified) (1 diff)
• annotations/Timezone.java (modified) (1 diff)

trunk/test/unit/org/openstreetmap/josm/testutils/PluginServer.java

@@ -25 +25 @@
 import org.openstreetmap.josm.tools.Logging;
 
+/**
+ * Serve "remote" test plugins for tests
+ */
 public class PluginServer {
+    /**
+     * A holder class for a "remote" plugin for tests
+     */
     public static class RemotePlugin {
         private final File srcJar;
@@ -226 +232 @@
     }
 
+    /**
+     * A wiremock server rule for serving plugins
+     */
     public class PluginServerRule extends WireMockExtension {
         public PluginServerRule(Options ruleOptions, boolean failOnUnmatchedRequests) {

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/ResetUniquePrimitiveIdCounters.java

@@ -37 +37 @@
 @ExtendWith(ResetUniquePrimitiveIdCounters.Reset.class)
 public @interface ResetUniquePrimitiveIdCounters {
+    /**
+     * Reset the id counters for {@link Node}, {@link Way}, and {@link Relation}
+     * {@link org.openstreetmap.josm.data.osm.AbstractPrimitive#getIdGenerator} calls.
+     */
     class Reset implements BeforeEachCallback {
         private static AtomicLong[] ID_COUNTERS;

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/TaggingPresets.java

@@ -32 +32 @@
 public @interface TaggingPresets {
 
+    /**
+     * Reset the tagging presets between each test -- presets will be reset if they are changed.
+     */
     class TaggingPresetsExtension implements BeforeEachCallback, BeforeAllCallback {
         private static int expectedHashcode = 0;

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/TestUser.java

@@ -33 +33 @@
 @Target({ElementType.TYPE, ElementType.METHOD})
 public @interface TestUser {
+    /**
+     * Initialize a user for tests
+     */
     class TestUserExtension implements BeforeAllCallback, BeforeEachCallback, AfterEachCallback {
         @Override

trunk/test/unit/org/openstreetmap/josm/testutils/annotations/Timezone.java

@@ -21 +21 @@
 @ExtendWith(Timezone.TimezoneExtension.class)
 public @interface Timezone {
+    /**
+     * Set the default timezone for tests (UTC)
+     */
     class TimezoneExtension implements BeforeEachCallback {
         @Override