Skip to content

Commit

Permalink
Fix javadoc references.
Browse files Browse the repository at this point in the history
Signed-off-by: Carsten Lohmann <[email protected]>
  • Loading branch information
calohmn committed Dec 3, 2021
1 parent 635b087 commit d9150f1
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public class TelemetrySenderTest extends AbstractAmqpAdapterClientDownstreamSend
private static final String ADDRESS = TelemetryConstants.TELEMETRY_ENDPOINT + "/" + TENANT_ID + "/" + DEVICE_ID;

/**
* Verifies that the message created by {@link TelemetrySender#send(String, byte[], String, Map)} conforms to the
* Verifies that the message created by {@link TelemetrySender#send(String, byte[], String, java.util.Map)} conforms to the
* expectations of the AMQP adapter.
*/
@Test
Expand All @@ -60,7 +60,7 @@ public void testSendCreatesValidMessage() {
}

/**
* Verifies that the message created by {@link TelemetrySender#sendAndWaitForOutcome(String, byte[], String, Map)}
* Verifies that the message created by {@link TelemetrySender#sendAndWaitForOutcome(String, byte[], String, java.util.Map)}
* conforms to the expectations of the AMQP adapter.
*
* @param ctx The test context to use for running asynchronous tests.
Expand All @@ -86,8 +86,8 @@ public void testSendAndWaitForOutcomeCreatesValidMessage(final VertxTestContext
}

/**
* Verifies that the message created by {@link TelemetrySender#send(String, byte[], String, Map)} conforms to the
* expectations of the AMQP adapter.
* Verifies that the message created by {@link TelemetrySender#send(String, byte[], String, java.util.Map)} conforms
* to the expectations of the AMQP adapter.
*/
@Test
public void testSendWithTracing() {
Expand All @@ -105,7 +105,7 @@ public void testSendWithTracing() {
}

/**
* Verifies that {@link TraceableTelemetrySender#sendAndWaitForOutcome(String, byte[], String, Map, SpanContext)}
* Verifies that {@link TraceableTelemetrySender#sendAndWaitForOutcome(String, byte[], String, java.util.Map, SpanContext)}
* uses the given SpanContext.
*
* @param ctx The test context to use for running asynchronous tests.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ public void testSendOneWayCommandSucceeds(final VertxTestContext ctx) {

/**
* Verifies that
* {@link org.eclipse.hono.application.client.CommandSender#sendCommand(String, String, String, String, Buffer, String, Map, Duration, SpanContext)}
* {@link org.eclipse.hono.application.client.CommandSender#sendCommand(String, String, String, String, Buffer, String, Map, Duration, io.opentracing.SpanContext)}
* fails as the timeout is reached.
*
* @param ctx The vert.x test context.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@
* <p>
* Producers are closed and removed from the cache if they throw a {@link #isFatalError(Throwable) fatal exception}.
* This is triggered by {@link KafkaProducer#exceptionHandler(Handler)} and run asynchronously after the
* {@link io.vertx.kafka.client.producer.impl.KafkaWriteStreamImpl#send(ProducerRecord, Handler) send operation} has
* finished. A following invocation of {@link #getOrCreateProducer(String, KafkaProducerConfigProperties)} will then
* return a new instance.
* {@link io.vertx.kafka.client.producer.impl.KafkaWriteStreamImpl#send(org.apache.kafka.clients.producer.ProducerRecord, Handler)
* send operation} has finished. A following invocation of {@link #getOrCreateProducer(String, KafkaProducerConfigProperties)}
* will then return a new instance.
*
* @param <K> The type for the record key serialization.
* @param <V> The type for the record value serialization.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public void testSendEventMarksMessageAsDurable() {

/**
* Verifies that a TTL values in the <em>properties</em> parameter of
* {@link org.eclipse.hono.client.telemetry.EventSender#sendEvent(TenantObject, RegistrationAssertion, String, Buffer, Map, SpanContext)}
* {@link org.eclipse.hono.client.telemetry.EventSender#sendEvent(TenantObject, RegistrationAssertion, String, Buffer, Map, io.opentracing.SpanContext)}
* are correctly taken as seconds and set as milliseconds at the message.
*/
@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ public void testThatConstructorThrowsOnMissingParameter() {

/**
* Verifies that
* {@link KafkaBasedTelemetrySender#sendTelemetry(TenantObject, RegistrationAssertion, QoS, String, Buffer, Map, SpanContext)}
* {@link KafkaBasedTelemetrySender#sendTelemetry(TenantObject, RegistrationAssertion, QoS, String, Buffer, Map, io.opentracing.SpanContext)}
* throws an NPE if a mandatory parameter is {@code null}.
*/
@Test
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public interface WebSpanDecorator {

/**
* Decorate span when the response is known. This is effectively invoked in BodyEndHandler which is added to
* - {@link io.vertx.ext.web.RoutingContext#addBodyEndHandler(Handler)}
* - {@link io.vertx.ext.web.RoutingContext#addBodyEndHandler(io.vertx.core.Handler)}
*
* @param request server request
* @param span server span
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
public class DeviceRegistryUtilsTest {

/**
* Verifies the conversion of a {@link Tenant} instance to a {@link TenantObject}.
* Verifies the conversion of a {@link Tenant} instance to a {@link org.eclipse.hono.util.TenantObject}.
*/
@Test
public void testTenantConversion() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
import io.vertx.junit5.VertxTestContext;

/**
* Tests for {@link FileBasedRegistrationService#searchDevices(String, int, int, List, List, Span)}.
* Tests for {@link FileBasedRegistrationService#searchDevices(String, int, int, List, List, io.opentracing.Span)}.
*/
@ExtendWith(VertxExtension.class)
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public GenericKafkaSender(
* <p>
* The future will be succeeded if the message has been sent.
* <p>
* The future will be failed with a {@link ServerErrorException} if the data could
* The future will be failed with a {@link org.eclipse.hono.client.ServerErrorException} if the data could
* not be sent. The error code contained in the exception indicates the cause of the failure.
* @throws NullPointerException if topic, tenantId, deviceId or properties are {@code null}.
*/
Expand All @@ -81,7 +81,7 @@ public Future<Void> sendAndWaitForOutcome(
* <p>
* The future will be succeeded if the message has been sent.
* <p>
* The future will be failed with a {@link ServerErrorException} if the data could
* The future will be failed with a {@link org.eclipse.hono.client.ServerErrorException} if the data could
* not be sent. The error code contained in the exception indicates the cause of the failure.
* @throws NullPointerException if topic, tenantId, deviceId or headers are {@code null}.
*/
Expand Down

0 comments on commit d9150f1

Please sign in to comment.