Fix javadoc issues (#120)

Signed-off-by: Mickael Maison <mickael.maison@gmail.com>

src/main/java/io/strimzi/test/container/StrimziKafkaCluster.java

@@ -427,7 +427,7 @@ public void stop() {
     }
 
     /**
-     * Get @code{StrimziZookeeperContainer} instance
+     * Get {@code StrimziZookeeperContainer} instance
      * @return StrimziZookeeperContainer instance
      */
     public StrimziZookeeperContainer getZookeeper() {

src/main/java/io/strimzi/test/container/StrimziKafkaContainer.java

@@ -44,9 +44,9 @@
 /**
  * StrimziKafkaContainer is a single-node instance of Kafka using the image from quay.io/strimzi/kafka with the
  * given version. There are two options for how to use it. The first one is using an embedded zookeeper which will run
- * inside Kafka container. The Another option is to use @StrimziZookeeperContainer as an external Zookeeper.
+ * inside Kafka container. The Another option is to use {@link StrimziZookeeperContainer} as an external Zookeeper.
  * The additional configuration for Kafka broker can be injected via constructor. This container is a good fit for
- * integration testing but for more hardcore testing we suggest using @StrimziKafkaCluster.
+ * integration testing but for more hardcore testing we suggest using {@link StrimziKafkaCluster}.
  * <br><br>
  * Optionally, you can configure a {@code proxyContainer} to simulate network conditions (i.e. connection cut, latency).
  * This class uses {@code getBootstrapServers()} to build the {@code KAFKA_ADVERTISED_LISTENERS} configuration.
@@ -614,7 +614,7 @@ public String getClusterId() {
     }
 
     /**
-     * Fluent method, which sets @code{kafkaConfigurationMap}.
+     * Fluent method, which sets {@code kafkaConfigurationMap}.
      *
      * @param kafkaConfigurationMap kafka configuration
      * @return StrimziKafkaContainer instance
@@ -625,7 +625,7 @@ public StrimziKafkaContainer withKafkaConfigurationMap(final Map<String, String>
     }
 
     /**
-     * Fluent method, which sets @code{externalZookeeperConnect}.
+     * Fluent method, which sets {@code externalZookeeperConnect}.
      * <p>
      * If the broker was created using Kraft, this method throws an {@link IllegalArgumentException}.
      *
@@ -641,7 +641,7 @@ public StrimziKafkaContainer withExternalZookeeperConnect(final String externalZ
     }
 
     /**
-     * Fluent method, which sets @code{brokerId}.
+     * Fluent method, which sets {@code brokerId}.
      *
      * @param brokerId broker id
      * @return StrimziKafkaContainer instance
@@ -667,7 +667,7 @@ public StrimziKafkaContainer withNodeId(final int nodeId) {
     }
 
     /**
-     * Fluent method, which sets @code{kafkaVersion}.
+     * Fluent method, which sets {@code kafkaVersion}.
      *
      * @param kafkaVersion kafka version
      * @return StrimziKafkaContainer instance
@@ -678,7 +678,7 @@ public StrimziKafkaContainer withKafkaVersion(final String kafkaVersion) {
     }
 
     /**
-     * Fluent method, which sets @code{useKraft}.
+     * Fluent method, which sets {@code useKraft}.
      * <p>
      * Flag to signal if we deploy Kafka with ZooKeeper or not.
      *

src/main/java/io/strimzi/test/container/StrimziZookeeperContainer.java

@@ -20,8 +20,8 @@
 
 /**
  * StrimziZookeeperContainer is an instance of the Zookeeper encapsulated inside a docker container using image from
- * quay.io/strimzi/kafka with the given version. It can be combined with @StrimziKafkaContainer but we suggest to use
- * directly @StrimziKafkaCluster for more complicated testing.
+ * quay.io/strimzi/kafka with the given version. It can be combined with {@link StrimziKafkaContainer} but we suggest to use
+ * directly {@link StrimziKafkaCluster} for more complicated testing.
  */
 @SuppressFBWarnings("EQ_DOESNT_OVERRIDE_EQUALS")
 public class StrimziZookeeperContainer extends GenericContainer<StrimziZookeeperContainer> {
@@ -123,7 +123,7 @@ public StrimziZookeeperContainer withZooKeeperPropertiesFile(final MountableFile
     }
 
     /**
-     * Fluent method, which sets @code{kafkaVersion}.
+     * Fluent method, which sets {@code kafkaVersion}.
      *
      * @param kafkaVersion kafka version
      * @return StrimziKafkaContainer instance

src/main/java/io/strimzi/test/container/WaitException.java

@@ -4,8 +4,12 @@
  */
 package io.strimzi.test.container;
 
+import java.time.Duration;
+import java.util.function.BooleanSupplier;
+
 /**
- * Extension for RuntimeException used in active waiting @see TestUtils.waitFor(...) method.
+ * Extension for RuntimeException used in active waiting. See the
+ * {@link Utils#waitFor(String, Duration, Duration, BooleanSupplier)} method.
  * Usage of this Exception should be always associated with active waiting where the condition
  * should not always be met which results in WaitException.
  */