Cleaned up Javadoc (#1433)

Signed-off-by: dhoard <doug.hoard@gmail.com>

Author: dhoard

integration_test_suite/integration_tests/src/main/java/io/prometheus/jmx/test/support/environment/IsolatorExporterTestEnvironment.java

@@ -128,7 +128,9 @@ public String getBaseUrl(int index) {
         return baseUrl + ":" + port;
     }
 
-    /** Method to destroy the test environment */
+    /**
+     * Method to destroy the test environment.
+     */
     public void destroy() {
         if (javaAgentApplicationContainer != null) {
             javaAgentApplicationContainer.stop();

integration_test_suite/integration_tests/src/main/java/io/prometheus/jmx/test/support/environment/JmxExporterTestEnvironment.java

@@ -166,7 +166,9 @@ public String getBaseUrl() {
         return baseUrl + ":" + port;
     }
 
-    /** Method to destroy the test environment */
+    /**
+     * Method to destroy the test environment.
+     */
     public void destroy() {
         if (javaAgentApplicationContainer != null) {
             javaAgentApplicationContainer.stop();

integration_test_suite/integration_tests/src/main/java/io/prometheus/jmx/test/support/environment/PrometheusTestEnvironment.java

@@ -134,7 +134,9 @@ private String getPrometheusBaseUrl() {
         return baseUrl + ":" + prometheusContainer.getMappedPort(9090);
     }
 
-    /** Method to wait for the Prometheus container to be ready */
+    /**
+     * Method to wait for the Prometheus container to be ready.
+     */
     public void waitForReady() {
         waitForReady(null, null);
     }
@@ -175,7 +177,9 @@ public void waitForReady(String username, String password) {
                 prometheusContainer.getDockerImageName(), System.currentTimeMillis() - startMilliseconds));
     }
 
-    /** Method to destroy the test environment */
+    /**
+     * Method to destroy the test environment.
+     */
     public void destroy() {
         if (prometheusContainer != null) {
             prometheusContainer.stop();

integration_test_suite/integration_tests/src/main/java/io/prometheus/jmx/test/support/http/HttpRequest.java

@@ -112,7 +112,9 @@ public static Builder builder() {
         return new Builder();
     }
 
-    /** Class to implement Builder */
+    /**
+     * Class to implement Builder.
+     */
     public static class Builder {
 
         private String url;

integration_test_suite/integration_tests/src/main/java/io/prometheus/jmx/test/support/metrics/MetricsParser.java

@@ -409,7 +409,9 @@ private static TreeMap<String, String> toLabels(List<Metrics.LabelPair> labelPai
         return labels;
     }
 
-    /** Class to read a Reader line by line with the ability to push a line back to the Reader */
+    /**
+     * Class to read a Reader line by line with the ability to push a line back to the Reader.
+     */
     private static class LineReader implements AutoCloseable {
 
         private final LinkedList<String> lineBuffer;

integration_test_suite/integration_tests/src/main/java/io/prometheus/jmx/test/support/util/Repeater.java

@@ -174,7 +174,9 @@ public void run() throws Throwable {
         }
     }
 
-    /** Method to abort a test */
+    /**
+     * Method to abort a test.
+     */
     public static void abort() {
         throw new RuntimeException("4dbf35e7-415c-4e66-a61e-f6a7057e382e");
     }
@@ -191,25 +193,33 @@ public static void rethrow(Throwable throwable) throws Throwable {
         }
     }
 
-    /** Interface to define code */
+    /**
+     * Interface to define code.
+     */
     public interface ThrowableRunnable {
 
         void run() throws Throwable;
     }
 
-    /** Interface to consume the result */
+    /**
+     * Interface to consume the result.
+     */
     public interface ThrowableConsumer {
 
         void accept(int counter, Throwable throwable) throws Throwable;
     }
 
-    /** Interface to implement a Throttle */
+    /**
+     * Interface to implement a Throttle.
+     */
     public interface Throttle {
 
         void throttle();
     }
 
-    /** Class to implement a fixed throttle */
+    /**
+     * Class to implement a fixed throttle.
+     */
     public static class FixedThrottle implements Throttle {
 
         private final long milliseconds;
@@ -233,7 +243,9 @@ public void throttle() {
         }
     }
 
-    /** Class to implement a random throttle */
+    /**
+     * Class to implement a random throttle.
+     */
     public static class RandomThrottle implements Throttle {
 
         private final long minMilliseconds;
@@ -273,7 +285,9 @@ public void throttle() {
         }
     }
 
-    /** Class to implement an exponential backoff throttle */
+    /**
+     * Class to implement an exponential backoff throttle.
+     */
     public static class ExponentialBackoffThrottle implements Throttle {
 
         private final long maxMilliseconds;

integration_test_suite/integration_tests/src/test/java/io/prometheus/jmx/test/opentelemetry/BasicAuthenticationTest.java

@@ -71,7 +71,9 @@ public void beforeAll(ArgumentContext argumentContext) {
         jmxExporterTestEnvironment.initialize(testClass, network);
     }
 
-    /** Method to test that metrics exist in Prometheus */
+    /**
+     * Method to test that metrics exist in Prometheus.
+     */
     @Verifyica.Test
     public void testPrometheusHasMetrics(ArgumentContext argumentContext) throws IOException {
         OpenTelemetryTestEnvironment openTelemetryTestEnvironment =

integration_test_suite/integration_tests/src/test/java/io/prometheus/jmx/test/opentelemetry/BasicTest.java

@@ -68,7 +68,9 @@ public void beforeAll(ArgumentContext argumentContext) {
         jmxExporterTestEnvironment.initialize(testClass, network);
     }
 
-    /** Method to test that metrics exist in Prometheus */
+    /**
+     * Method to test that metrics exist in Prometheus.
+     */
     @Verifyica.Test
     public void testPrometheusHasMetrics(OpenTelemetryTestEnvironment openTelemetryTestEnvironment) throws IOException {
         PrometheusTestEnvironment prometheusTestEnvironment = openTelemetryTestEnvironment.prometheusTestEnvironment();

integration_test_suite/integration_tests/src/test/java/io/prometheus/jmx/test/opentelemetry/CombinedModeTest.java

@@ -149,7 +149,9 @@ public void testPrometheusProtobufMetrics(OpenTelemetryTestEnvironment openTelem
         assertMetricsResponse(jmxExporterTestEnvironment, httpResponse, MetricsContentType.PROMETHEUS_PROTOBUF_METRICS);
     }
 
-    /** Method to test that metrics exist in Prometheus */
+    /**
+     * Method to test that metrics exist in Prometheus.
+     */
     @Verifyica.Test
     @Verifyica.Order(6)
     public void testPrometheusHasMetrics(OpenTelemetryTestEnvironment openTelemetryTestEnvironment) throws IOException {

integration_test_suite/integration_tests/src/test/java/io/prometheus/jmx/test/opentelemetry/ConfigurationTest.java

@@ -80,7 +80,9 @@ public void beforeAll(ArgumentContext argumentContext) {
         jmxExporterTestEnvironment.initialize(testClass, network);
     }
 
-    /** Method to test that metrics exist in Prometheus */
+    /**
+     * Method to test that metrics exist in Prometheus.
+     */
     @Verifyica.Test
     public void testPrometheusHasMetrics(OpenTelemetryTestEnvironment openTelemetryTestEnvironment) throws IOException {
         JmxExporterTestEnvironment jmxExporterTestEnvironment = openTelemetryTestEnvironment.exporterTestEnvironment();