Skip to content

Commit da39e21

Browse files
authored
Fix javadoc warnings (#7317)
1 parent 8edcc18 commit da39e21

File tree

27 files changed

+39
-36
lines changed

27 files changed

+39
-36
lines changed

core/src/main/java/org/testcontainers/containers/GenericContainer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ public GenericContainer(@NonNull final RemoteDockerImage image) {
247247
}
248248

249249
/**
250-
* @deprecated use {@link GenericContainer(DockerImageName)} instead
250+
* @deprecated use {@link #GenericContainer(DockerImageName)} instead
251251
*/
252252
@Deprecated
253253
public GenericContainer() {

modules/clickhouse/src/main/java/org/testcontainers/containers/ClickHouseContainer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public class ClickHouseContainer extends JdbcDatabaseContainer<ClickHouseContain
4343
private boolean supportsNewDriver;
4444

4545
/**
46-
* @deprecated use {@link ClickHouseContainer(DockerImageName)} instead
46+
* @deprecated use {@link #ClickHouseContainer(DockerImageName)} instead
4747
*/
4848
@Deprecated
4949
public ClickHouseContainer() {

modules/cockroachdb/src/main/java/org/testcontainers/containers/CockroachContainer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public class CockroachContainer extends JdbcDatabaseContainer<CockroachContainer
4141
private boolean isVersionGreaterThanOrEqualTo221;
4242

4343
/**
44-
* @deprecated use {@link CockroachContainer(DockerImageName)} instead
44+
* @deprecated use {@link #CockroachContainer(DockerImageName)} instead
4545
*/
4646
@Deprecated
4747
public CockroachContainer() {

modules/couchbase/src/main/java/org/testcontainers/couchbase/CouchbaseContainer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ public class CouchbaseContainer extends GenericContainer<CouchbaseContainer> {
118118

119119
/**
120120
* Creates a new couchbase container with the default image and version.
121-
* @deprecated use {@link CouchbaseContainer(DockerImageName)} instead
121+
* @deprecated use {@link #CouchbaseContainer(DockerImageName)} instead
122122
*/
123123
@Deprecated
124124
public CouchbaseContainer() {

modules/db2/src/main/java/org/testcontainers/containers/Db2Container.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ public class Db2Container extends JdbcDatabaseContainer<Db2Container> {
2929
private String password = "foobar1234";
3030

3131
/**
32-
* @deprecated use {@link Db2Container(DockerImageName)} instead
32+
* @deprecated use {@link #Db2Container(DockerImageName)} instead
3333
*/
3434
@Deprecated
3535
public Db2Container() {

modules/dynalite/src/main/java/org/testcontainers/dynamodb/DynaliteContainer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public class DynaliteContainer extends GenericContainer<DynaliteContainer> {
2323
private static final int MAPPED_PORT = 4567;
2424

2525
/**
26-
* @deprecated use {@link DynaliteContainer(DockerImageName)} instead
26+
* @deprecated use {@link #DynaliteContainer(DockerImageName)} instead
2727
*/
2828
@Deprecated
2929
public DynaliteContainer() {

modules/elasticsearch/src/main/java/org/testcontainers/elasticsearch/ElasticsearchContainer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public class ElasticsearchContainer extends GenericContainer<ElasticsearchContai
7272
private String certPath = "/usr/share/elasticsearch/config/certs/http_ca.crt";
7373

7474
/**
75-
* @deprecated use {@link ElasticsearchContainer(DockerImageName)} instead
75+
* @deprecated use {@link #ElasticsearchContainer(DockerImageName)} instead
7676
*/
7777
@Deprecated
7878
public ElasticsearchContainer() {

modules/influxdb/src/main/java/org/testcontainers/containers/InfluxDBContainer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,15 @@ public class InfluxDBContainer<SELF extends InfluxDBContainer<SELF>> extends Gen
6363
private final boolean isAtLeastMajorVersion2;
6464

6565
/**
66-
* @deprecated use {@link InfluxDBContainer(DockerImageName)} instead
66+
* @deprecated use {@link #InfluxDBContainer(DockerImageName)} instead
6767
*/
6868
@Deprecated
6969
public InfluxDBContainer() {
7070
this(DEFAULT_IMAGE_NAME.withTag(DEFAULT_TAG));
7171
}
7272

7373
/**
74-
* @deprecated use {@link InfluxDBContainer(DockerImageName)} instead
74+
* @deprecated use {@link #InfluxDBContainer(DockerImageName)} instead
7575
*/
7676
@Deprecated
7777
public InfluxDBContainer(final String version) {

modules/jdbc/src/main/java/org/testcontainers/containers/JdbcDatabaseContainer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public abstract class JdbcDatabaseContainer<SELF extends JdbcDatabaseContainer<S
4747
private static final String QUERY_PARAM_SEPARATOR = "&";
4848

4949
/**
50-
* @deprecated use {@link JdbcDatabaseContainer(DockerImageName)} instead
50+
* @deprecated use {@link #JdbcDatabaseContainer(DockerImageName)} instead
5151
*/
5252
public JdbcDatabaseContainer(@NonNull final String dockerImageName) {
5353
this(DockerImageName.parse(dockerImageName));

modules/junit-jupiter/src/main/java/org/testcontainers/junit/jupiter/Testcontainers.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* {@code @Testcontainers} is a JUnit Jupiter extension to activate automatic
1313
* startup and stop of containers used in a test case.
1414
*
15-
* <p>The test containers extension finds all fields that are annotated with
15+
* <p>The Testcontainers extension finds all fields that are annotated with
1616
* {@link Container} and calls their container lifecycle methods. Containers
1717
* declared as static fields will be shared between test methods. They will be
1818
* started only once before any test method is executed and stopped after the
@@ -60,12 +60,15 @@
6060
@Inherited
6161
public @interface Testcontainers {
6262
/**
63-
* Whether tests should be disabled (rather than failing) when Docker is not available.
63+
* Whether tests should be disabled (rather than failing) when Docker is not available. Defaults to
64+
* {@code false}.
65+
* @return if the tests should be disabled when Docker is not available
6466
*/
6567
boolean disabledWithoutDocker() default false;
6668

6769
/**
68-
* Whether containers should start in parallel
70+
* Whether containers should start in parallel. Defaults to {@code false}.
71+
* @return if the containers should start in parallel
6972
*/
7073
boolean parallel() default false;
7174
}

0 commit comments

Comments
 (0)