Issue #87: Minor review findings fixed

Signed-off-by: David Schwilk <david.schwilk@bosch.io>
eclipse-ditto · Sep 29, 2020 · e2ece43 · e2ece43
1 parent 80081a3
commit e2ece43
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/java/src/main/java/org/eclipse/ditto/client/DittoClients.java b/java/src/main/java/org/eclipse/ditto/client/DittoClients.java
@@ -137,7 +137,7 @@ public static DittoClient newInstance(final MessagingProvider twinMessagingProvi
 
     /**
      * Creates a new {@link org.eclipse.ditto.client.DittoClient} with a shared {@code Twin} and {@code Live}
-     * {@link org.eclipse.ditto.client.messaging.MessagingProvider} but do not attempt to connect to the configured
+     * {@link org.eclipse.ditto.client.messaging.MessagingProvider} but does not attempt to connect to the configured
      * back-end.
      *
      * @param messagingProvider the messaging provider for this client.
@@ -151,8 +151,8 @@ public static DisconnectedDittoClient newDisconnectedInstance(final MessagingPro
 
     /**
      * Creates a new {@link org.eclipse.ditto.client.DittoClient} with a specific {@code Twin}, {@code Live} and
-     * {@code Policy} {@link org.eclipse.ditto.client.messaging.MessagingProvider} but do not attempt to the configured
-     * back-end.
+     * {@code Policy} {@link org.eclipse.ditto.client.messaging.MessagingProvider} but does not attempt to connect to
+     * the configured back-end.
      *
      * @param twinMessagingProvider the messaging provider for the {@code Twin} part of the client.
      * @param liveMessagingProvider the messaging provider for the {@code Live} part of the client.

diff --git a/java/src/main/java/org/eclipse/ditto/client/messaging/MessagingProvider.java b/java/src/main/java/org/eclipse/ditto/client/messaging/MessagingProvider.java
@@ -42,7 +42,7 @@ public interface MessagingProvider {
     /**
      * Initializes the Messaging Provider by opening the underlying connections, etc.
      * Blocks the calling thread until messaging provider is ready.
-     * Use {@code initializeAsync} instead.
+     * @deprecated since 1.3.0. Use {@code initializeAsync} instead.
      */
     @Deprecated
     default void initialize() {
@@ -52,7 +52,7 @@ default void initialize() {
     /**
      * Perform initialization asynchronously.
      *
-     * @return a future that completes after initialization completes.
+     * @return a future that completes after initialization completed.
      * @since 1.3.0
      */
     CompletionStage<?> initializeAsync();