Fix doclint errors and enable doclint

Signed-off-by: Felix Barnsteiner <[email protected]>

Author: felixbarny

apm-agent-api/pom.xml

@@ -8,7 +8,7 @@
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>apm-agent-api</artifactId>
-    <name>${groupId}:${artifactId}</name>
+    <name>${project.groupId}:${project.artifactId}</name>
 
 
 </project>

apm-agent-api/src/main/java/co/elastic/apm/api/ElasticApm.java

@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -29,13 +29,12 @@
  * <pre>{@code
  * private static final ElasticApm elasticApm = ElasticApm.get();
  * }</pre>
- * <p>
+ *
  * Then you can access the tracer to set a custom transaction name,
  * for example:
  * <pre>{@code
  * elasticApm.currentTransaction().setName("SuchController#muchMethod");
  * }</pre>
- * <p/>
  */
 public class ElasticApm implements Tracer {
 
@@ -55,7 +54,7 @@ private ElasticApm() {
     /**
      * Returns the tracer implementation.
      *
-     * @return the tracer implementation (never <code>null</code>)
+     * @return the tracer implementation (never {@code null})
      */
     @Nonnull
     public static ElasticApm get() {
@@ -69,7 +68,7 @@ public static ElasticApm get() {
      * This method is called by the actual {@link Tracer} implementation.
      * </p>
      * <p>
-     * Users are not supposed to set a custom instrumentation so this method must not be <code>public</code>.
+     * Users are not supposed to set a custom instrumentation so this method must not be {@code public}.
      * Otherwise it would be part of the public API.
      * </p>
      * <p>
@@ -108,10 +107,10 @@ public Transaction startTransaction() {
      * Returns the currently running transaction.
      * <p>
      * If there is no current transaction, this method will return a noop transaction,
-     * which means that you never have to check for <code>null</code> values.
+     * which means that you never have to check for {@code null} values.
      * </p>
      *
-     * @return The currently running transaction, or a noop transaction (never <code>null</code>).
+     * @return The currently running transaction, or a noop transaction (never {@code null}).
      */
     @Override
     @Nonnull
@@ -124,10 +123,10 @@ public Transaction currentTransaction() {
      * Returns the currently running span.
      * <p>
      * If there is no current span, this method will return a noop span,
-     * which means that you never have to check for <code>null</code> values.
+     * which means that you never have to check for {@code null} values.
      * </p>
      *
-     * @return The currently running span, or a noop span (never <code>null</code>).
+     * @return The currently running span, or a noop span (never {@code null}).
      */
     @Override
     @Nonnull

apm-agent-api/src/main/java/co/elastic/apm/api/Tracer.java

@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -63,7 +63,7 @@ public interface Tracer {
     /**
      * Returns the currently active span
      *
-     * @return The currently active span.
+     * @return the currently active span
      */
     @Nullable
     Span currentSpan();
@@ -82,12 +82,16 @@ public interface Tracer {
      *     // do your thing...
      * }
      * </pre>
+     *
+     * @return the started span
      */
     @Nonnull
     Span startSpan();
 
     /**
      * Captures an exception and reports it to the APM server.
+     *
+     * @param e the exception to record
      */
     void captureException(@Nonnull Exception e);
 }

apm-agent-api/src/main/java/co/elastic/apm/api/Transaction.java

@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -79,9 +79,9 @@ public interface Transaction extends AutoCloseable {
      * If an error is captured, the context from the active transaction is used as context for the captured error.
      * </p>
      *
-     * @param id       The user's id or <code>null</code>, if not applicable.
-     * @param email    The user's email address or <code>null</code>, if not applicable.
-     * @param username The user's name or <code>null</code>, if not applicable.
+     * @param id       The user's id or {@code null}, if not applicable.
+     * @param email    The user's email address or {@code null}, if not applicable.
+     * @param username The user's name or {@code null}, if not applicable.
      */
     void setUser(String id, String email, String username);
 

apm-agent-benchmarks/pom.xml

@@ -8,7 +8,7 @@
     </parent>
 
     <artifactId>apm-agent-benchmarks</artifactId>
-    <name>${groupId}:${artifactId}</name>
+    <name>${project.groupId}:${project.artifactId}</name>
     <packaging>jar</packaging>
 
 

apm-agent-benchmarks/src/main/java/co/elastic/apm/impl/AbstractHttpJacksonReporterBenchmark.java

@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -36,8 +36,8 @@ public abstract class AbstractHttpJacksonReporterBenchmark extends AbstractHttpR
     /**
      * Convenience benchmark run method
      * <p>
-     * For more accurate results, execute <code>mvn clean package</code> and run the benchmark via
-     * <code>java -jar apm-agent-benchmarks/target/benchmarks.jar -prof gc</code>
+     * For more accurate results, execute {@code mvn clean package} and run the benchmark via
+     * {@code java -jar apm-agent-benchmarks/target/benchmarks.jar -prof gc}
      */
     public static void main(String[] args) throws RunnerException {
         new Runner(new OptionsBuilder()

apm-agent-benchmarks/src/main/java/co/elastic/apm/impl/HttpCborJacksonReporterBenchmark.java

@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -32,8 +32,8 @@ public class HttpCborJacksonReporterBenchmark extends AbstractHttpJacksonReporte
     /**
      * Convenience benchmark run method
      * <p>
-     * For more accurate results, execute <code>mvn clean package</code> and run the benchmark via
-     * <code>java -jar apm-agent-benchmarks/target/benchmarks.jar -prof gc</code>
+     * For more accurate results, execute {@code mvn clean package} and run the benchmark via
+     * {@code java -jar apm-agent-benchmarks/target/benchmarks.jar -prof gc}
      */
     public static void main(String[] args) throws RunnerException {
         new Runner(new OptionsBuilder()

apm-agent-benchmarks/src/main/java/co/elastic/apm/impl/HttpMoshiReporterBenchmark.java

@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -31,8 +31,8 @@ public class HttpMoshiReporterBenchmark extends AbstractHttpReporterBenchmark {
     /**
      * Convenience benchmark run method
      * <p>
-     * For more accurate results, execute <code>mvn clean package</code> and run the benchmark via
-     * <code>java -jar apm-agent-benchmarks/target/benchmarks.jar -prof gc</code>
+     * For more accurate results, execute {@code mvn clean package} and run the benchmark via
+     * {@code java -jar apm-agent-benchmarks/target/benchmarks.jar -prof gc}
      */
     public static void main(String[] args) throws RunnerException {
         new Runner(new OptionsBuilder()

apm-agent-benchmarks/src/main/java/co/elastic/apm/impl/HttpNoopJsonReporterBenchmark.java

@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -30,8 +30,8 @@ public class HttpNoopJsonReporterBenchmark extends AbstractHttpReporterBenchmark
     /**
      * Convenience benchmark run method
      * <p>
-     * For more accurate results, execute <code>mvn clean package</code> and run the benchmark via
-     * <code>java -jar apm-agent-benchmarks/target/benchmarks.jar -prof gc</code>
+     * For more accurate results, execute {@code mvn clean package} and run the benchmark via
+     * {@code java -jar apm-agent-benchmarks/target/benchmarks.jar -prof gc}
      */
     public static void main(String[] args) throws RunnerException {
         new Runner(new OptionsBuilder()

apm-agent-benchmarks/src/main/java/co/elastic/apm/impl/HttpVanillaJacksonReporterBenchmark.java

@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -31,8 +31,8 @@ public class HttpVanillaJacksonReporterBenchmark extends AbstractHttpJacksonRepo
     /**
      * Convenience benchmark run method
      * <p>
-     * For more accurate results, execute <code>mvn clean package</code> and run the benchmark via
-     * <code>java -jar apm-agent-benchmarks/target/benchmarks.jar -prof gc</code>
+     * For more accurate results, execute {@code mvn clean package} and run the benchmark via
+     * {@code java -jar apm-agent-benchmarks/target/benchmarks.jar -prof gc}
      */
     public static void main(String[] args) throws RunnerException {
         new Runner(new OptionsBuilder()