From ddd5619df10e287545bfe593caac39059966f325 Mon Sep 17 00:00:00 2001 From: yvgopal Date: Wed, 31 May 2017 16:08:34 -0700 Subject: [PATCH] Fixing javadoc generation errors (#60) --- .../microsoft/azure/servicebus/ISessionHandler.java | 4 ++-- .../azure/servicebus/MessageHandlerOptions.java | 4 ++-- .../azure/servicebus/SessionHandlerOptions.java | 13 +++++++------ .../primitives/ConnectionStringBuilder.java | 12 ++++++------ .../azure/servicebus/primitives/Timer.java | 5 ++--- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/ISessionHandler.java b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/ISessionHandler.java index dc17821cb2984..b9f6f18609ff6 100644 --- a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/ISessionHandler.java +++ b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/ISessionHandler.java @@ -8,8 +8,8 @@ public interface ISessionHandler /** * Called just before a session is closed by the session pump - * @param session - * @return + * @param session session being closed + * @return a future that executes the action */ public CompletableFuture OnCloseSessionAsync(IMessageSession session); diff --git a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/MessageHandlerOptions.java b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/MessageHandlerOptions.java index 0af680119ebd6..fcf50067fa30a 100644 --- a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/MessageHandlerOptions.java +++ b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/MessageHandlerOptions.java @@ -19,8 +19,8 @@ public MessageHandlerOptions() /** * - * @param maxConcurrentCalls - * @param autoComplete + * @param maxConcurrentCalls maximum number of concurrent calls to the onMessage handler + * @param autoComplete true if the pump should automatically complete message after onMessageHandler action is completed. false otherwise. * @param maxAutoRenewDuration - Maximum duration within which the client keeps renewing the message lock if the processing of the message is not completed by the handler. */ public MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration) diff --git a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/SessionHandlerOptions.java b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/SessionHandlerOptions.java index 845d4f8067764..0e4cfefe88203 100644 --- a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/SessionHandlerOptions.java +++ b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/SessionHandlerOptions.java @@ -20,8 +20,8 @@ public SessionHandlerOptions() /** * - * @param maxConcurrentSessions - * @param autoComplete + * @param maxConcurrentSessions maximum number of concurrent sessions accepted by the session pump + * @param autoComplete true if the pump should automatically complete message after onMessageHandler action is completed. false otherwise. * @param maxAutoRenewDuration - Maximum duration within which the client keeps renewing the session lock if the processing of the session messages or onclose action * is not completed by the handler. */ @@ -32,10 +32,11 @@ public SessionHandlerOptions(int maxConcurrentSessions, boolean autoComplete, Du /** * - * @param maxConcurrentSessions - * @param maxConcurrentCallsPerSession - * @param autoComplete - * @param maxAutoRenewDuration + * @param maxConcurrentSessions maximum number of concurrent sessions accepted by the session pump + * @param maxConcurrentCallsPerSession maximum number of concurrent calls to the onMessage handler + * @param autoComplete true if the pump should automatically complete message after onMessageHandler action is completed. false otherwise + * @param maxAutoRenewDuration Maximum duration within which the client keeps renewing the session lock if the processing of the session messages or onclose action + * is not completed by the handler. */ public SessionHandlerOptions(int maxConcurrentSessions, int maxConcurrentCallsPerSession, boolean autoComplete, Duration maxAutoRenewDuration) { diff --git a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/primitives/ConnectionStringBuilder.java b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/primitives/ConnectionStringBuilder.java index ff7b285c3eaf1..fef1c47b95d1e 100644 --- a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/primitives/ConnectionStringBuilder.java +++ b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/primitives/ConnectionStringBuilder.java @@ -124,7 +124,7 @@ private ConnectionStringBuilder( /** * Build a connection string * @param namespaceName Namespace name (dns suffix - ex: .servicebus.windows.net is not required) - * @param entityPath Entity path. For queue or topic, use name. For subscription use /subscriptions/. + * @param entityPath Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName> * @param sharedAccessKeyName Shared Access Key name * @param sharedAccessKey Shared Access Key */ @@ -140,22 +140,22 @@ public ConnectionStringBuilder( /** * Build a connection string * @param namespaceName Namespace name (dns suffix - ex: .servicebus.windows.net is not required) - * @param entityPath Entity path. For queue or topic, use name. For subscription use /subscriptions/. + * @param entityPath Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName> * @param sharedAccessSingature Shared Access Signature already generated */ public ConnectionStringBuilder( final String namespaceName, final String entityPath, - final String sharedAccessSingatureToken) + final String sharedAccessSingature) { - this(namespaceName, entityPath, sharedAccessSingatureToken, MessagingFactory.DefaultOperationTimeout, RetryPolicy.getDefault()); + this(namespaceName, entityPath, sharedAccessSingature, MessagingFactory.DefaultOperationTimeout, RetryPolicy.getDefault()); } /** * Build a connection string * @param endpointAddress namespace level endpoint. This needs to be in the format of scheme://fullyQualifiedServiceBusNamespaceEndpointName - * @param entityPath Entity path. For queue or topic, use name. For subscription use /subscriptions/. + * @param entityPath Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName> * @param sharedAccessKeyName Shared Access Key name * @param sharedAccessKey Shared Access Key */ @@ -171,7 +171,7 @@ public ConnectionStringBuilder( /** * Build a connection string * @param endpointAddress namespace level endpoint. This needs to be in the format of scheme://fullyQualifiedServiceBusNamespaceEndpointName - * @param entityPath Entity path. For queue or topic, use name. For subscription use /subscriptions/. + * @param entityPath Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName> * @param sharedAccessSingature Shared Access Signature already generated */ public ConnectionStringBuilder( diff --git a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/primitives/Timer.java b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/primitives/Timer.java index 04b5735de34ca..5fa8d539964f3 100644 --- a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/primitives/Timer.java +++ b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/primitives/Timer.java @@ -29,9 +29,8 @@ private Timer() { } - /** - * @param runFrequency implemented only for TimeUnit granularity - Seconds - */ + + // runFrequency implemented only for TimeUnit granularity - Seconds public static ScheduledFuture schedule(Runnable runnable, Duration runFrequency, TimerType timerType) { switch (timerType)