Skip to content

Commit 012ae66

Browse files
committed
Improve Javadoc
1 parent f2a46ff commit 012ae66

4 files changed

Lines changed: 10 additions & 10 deletions

File tree

web/src/main/java/io/spine/web/subscription/SubscriptionBridge.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public interface SubscriptionBridge<S extends Message, K extends Message, C exte
5959
S subscribe(Topic topic);
6060

6161
/**
62-
* Keep up the subscription, preventing it from closing from the server.
62+
* Keeps up the subscription, preventing it from closing from the server.
6363
*
6464
* <p>This operation is performed because a subscription lifetime is finite. Server cancels
6565
* all subscriptions at some point, because maintaining them requires resources and the client
@@ -77,7 +77,7 @@ public interface SubscriptionBridge<S extends Message, K extends Message, C exte
7777
K keepUp(Subscription subscription);
7878

7979
/**
80-
* Keep up given subscriptions, preventing them from closing from the server.
80+
* Keeps up given subscriptions, preventing them from closing from the server.
8181
*
8282
* <p>This operation is performed because a subscription lifetime is finite. Server cancels
8383
* all subscriptions at some point, because maintaining them requires resources and the client
@@ -95,7 +95,7 @@ public interface SubscriptionBridge<S extends Message, K extends Message, C exte
9595
Responses keepUpAll(Subscriptions subscription);
9696

9797
/**
98-
* Cancel the existing subscription.
98+
* Cancels the existing subscription.
9999
*
100100
* <p>After this call, the server will stop sending subscription updates to the client.
101101
*
@@ -106,7 +106,7 @@ public interface SubscriptionBridge<S extends Message, K extends Message, C exte
106106
C cancel(Subscription subscription);
107107

108108
/**
109-
* Cancel existing subscriptions.
109+
* Cancels existing subscriptions.
110110
*
111111
* <p>After this call, the server will stop sending subscription updates to the clients.
112112
*

web/src/main/java/io/spine/web/subscription/servlet/SubscriptionBulkKeepUpServlet.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
import static com.google.common.base.Preconditions.checkNotNull;
3636

3737
/**
38-
* An abstract servlet for a client request to keep up an existing {@link Subscription}.
38+
* An abstract servlet handling the bulk {@link Subscription} keep-up requests.
3939
*
4040
* <p>This servlet parses the client requests and passes it to the {@link SubscriptionBridge}
4141
* to process. After, a processing result is written to the servlet response.
@@ -47,11 +47,11 @@ public abstract class SubscriptionBulkKeepUpServlet
4747
private final SubscriptionBridge<?, ?, ?> bridge;
4848

4949
/**
50-
* Creates a new instance of {@code SubscriptionBulkKeepUpServlet} with the given
51-
* {@link SubscriptionBridge}.
50+
* Creates a new instance of {@code SubscriptionBulkKeepUpServlet} with
51+
* the given {@link SubscriptionBridge}.
5252
*
5353
* @param bridge
54-
* the subscription bridge to be used to keep-up subscriptions
54+
* the subscription bridge to be used to keep up subscriptions
5555
*/
5656
protected SubscriptionBulkKeepUpServlet(SubscriptionBridge<?, ?, ?> bridge) {
5757
super();

web/src/main/java/io/spine/web/subscription/servlet/SubscriptionCancelAllServlet.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public abstract class SubscriptionCancelAllServlet
4949
* {@link SubscriptionBridge}.
5050
*
5151
* @param bridge
52-
* the subscription bridge to be used in to cancel subscriptions
52+
* the subscription bridge to be used to cancel subscriptions
5353
*/
5454
protected SubscriptionCancelAllServlet(SubscriptionBridge<?, ?, ?> bridge) {
5555
super();

web/src/main/java/io/spine/web/subscription/servlet/SubscriptionKeepUpServlet.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public abstract class SubscriptionKeepUpServlet<T extends Message>
5151
* {@link SubscriptionBridge}.
5252
*
5353
* @param bridge
54-
* the subscription bridge to be used to keep-up subscriptions
54+
* the subscription bridge to be used to keep up subscriptions
5555
*/
5656
protected SubscriptionKeepUpServlet(SubscriptionBridge<?, T, ?> bridge) {
5757
super();

0 commit comments

Comments
 (0)