Skip to content

Commit ddd5619

Browse files
yvgopaljtaubensee
authored andcommitted
Fixing javadoc generation errors (#60)
1 parent 3533662 commit ddd5619

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

azure-servicebus/src/main/java/com/microsoft/azure/servicebus/ISessionHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ public interface ISessionHandler
88

99
/**
1010
* Called just before a session is closed by the session pump
11-
* @param session
12-
* @return
11+
* @param session session being closed
12+
* @return a future that executes the action
1313
*/
1414
public CompletableFuture<Void> OnCloseSessionAsync(IMessageSession session);
1515

azure-servicebus/src/main/java/com/microsoft/azure/servicebus/MessageHandlerOptions.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ public MessageHandlerOptions()
1919

2020
/**
2121
*
22-
* @param maxConcurrentCalls
23-
* @param autoComplete
22+
* @param maxConcurrentCalls maximum number of concurrent calls to the onMessage handler
23+
* @param autoComplete true if the pump should automatically complete message after onMessageHandler action is completed. false otherwise.
2424
* @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.
2525
*/
2626
public MessageHandlerOptions(int maxConcurrentCalls, boolean autoComplete, Duration maxAutoRenewDuration)

azure-servicebus/src/main/java/com/microsoft/azure/servicebus/SessionHandlerOptions.java

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ public SessionHandlerOptions()
2020

2121
/**
2222
*
23-
* @param maxConcurrentSessions
24-
* @param autoComplete
23+
* @param maxConcurrentSessions maximum number of concurrent sessions accepted by the session pump
24+
* @param autoComplete true if the pump should automatically complete message after onMessageHandler action is completed. false otherwise.
2525
* @param maxAutoRenewDuration - Maximum duration within which the client keeps renewing the session lock if the processing of the session messages or onclose action
2626
* is not completed by the handler.
2727
*/
@@ -32,10 +32,11 @@ public SessionHandlerOptions(int maxConcurrentSessions, boolean autoComplete, Du
3232

3333
/**
3434
*
35-
* @param maxConcurrentSessions
36-
* @param maxConcurrentCallsPerSession
37-
* @param autoComplete
38-
* @param maxAutoRenewDuration
35+
* @param maxConcurrentSessions maximum number of concurrent sessions accepted by the session pump
36+
* @param maxConcurrentCallsPerSession maximum number of concurrent calls to the onMessage handler
37+
* @param autoComplete true if the pump should automatically complete message after onMessageHandler action is completed. false otherwise
38+
* @param maxAutoRenewDuration Maximum duration within which the client keeps renewing the session lock if the processing of the session messages or onclose action
39+
* is not completed by the handler.
3940
*/
4041
public SessionHandlerOptions(int maxConcurrentSessions, int maxConcurrentCallsPerSession, boolean autoComplete, Duration maxAutoRenewDuration)
4142
{

azure-servicebus/src/main/java/com/microsoft/azure/servicebus/primitives/ConnectionStringBuilder.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ private ConnectionStringBuilder(
124124
/**
125125
* Build a connection string
126126
* @param namespaceName Namespace name (dns suffix - ex: .servicebus.windows.net is not required)
127-
* @param entityPath Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName>.
127+
* @param entityPath Entity path. For queue or topic, use name. For subscription use &lt;topicName&gt;/subscriptions/&lt;subscriptionName&gt;
128128
* @param sharedAccessKeyName Shared Access Key name
129129
* @param sharedAccessKey Shared Access Key
130130
*/
@@ -140,22 +140,22 @@ public ConnectionStringBuilder(
140140
/**
141141
* Build a connection string
142142
* @param namespaceName Namespace name (dns suffix - ex: .servicebus.windows.net is not required)
143-
* @param entityPath Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName>.
143+
* @param entityPath Entity path. For queue or topic, use name. For subscription use &lt;topicName&gt;/subscriptions/&lt;subscriptionName&gt;
144144
* @param sharedAccessSingature Shared Access Signature already generated
145145
*/
146146
public ConnectionStringBuilder(
147147
final String namespaceName,
148148
final String entityPath,
149-
final String sharedAccessSingatureToken)
149+
final String sharedAccessSingature)
150150
{
151-
this(namespaceName, entityPath, sharedAccessSingatureToken, MessagingFactory.DefaultOperationTimeout, RetryPolicy.getDefault());
151+
this(namespaceName, entityPath, sharedAccessSingature, MessagingFactory.DefaultOperationTimeout, RetryPolicy.getDefault());
152152
}
153153

154154

155155
/**
156156
* Build a connection string
157157
* @param endpointAddress namespace level endpoint. This needs to be in the format of scheme://fullyQualifiedServiceBusNamespaceEndpointName
158-
* @param entityPath Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName>.
158+
* @param entityPath Entity path. For queue or topic, use name. For subscription use &lt;topicName&gt;/subscriptions/&lt;subscriptionName&gt;
159159
* @param sharedAccessKeyName Shared Access Key name
160160
* @param sharedAccessKey Shared Access Key
161161
*/
@@ -171,7 +171,7 @@ public ConnectionStringBuilder(
171171
/**
172172
* Build a connection string
173173
* @param endpointAddress namespace level endpoint. This needs to be in the format of scheme://fullyQualifiedServiceBusNamespaceEndpointName
174-
* @param entityPath Entity path. For queue or topic, use name. For subscription use <topicName>/subscriptions/<subscriptionName>.
174+
* @param entityPath Entity path. For queue or topic, use name. For subscription use &lt;topicName&gt;/subscriptions/&lt;subscriptionName&gt;
175175
* @param sharedAccessSingature Shared Access Signature already generated
176176
*/
177177
public ConnectionStringBuilder(

azure-servicebus/src/main/java/com/microsoft/azure/servicebus/primitives/Timer.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,8 @@ private Timer()
2929
{
3030
}
3131

32-
/**
33-
* @param runFrequency implemented only for TimeUnit granularity - Seconds
34-
*/
32+
33+
// runFrequency implemented only for TimeUnit granularity - Seconds
3534
public static ScheduledFuture<?> schedule(Runnable runnable, Duration runFrequency, TimerType timerType)
3635
{
3736
switch (timerType)

0 commit comments

Comments
 (0)