Fixing a java doc comment (#182)

* Javadoc fixes * Setting project source encoding to UTF-8
Azure · Jan 19, 2018 · 2932f2d · 2932f2d
1 parent edcd804
commit 2932f2d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 8 deletions.
diff --git a/azure-servicebus/pom.xml b/azure-servicebus/pom.xml
@@ -11,6 +11,11 @@
 		<artifactId>azure-servicebus-parent</artifactId>
 		<version>1.2.3-PREVIEW</version>
 	</parent>
+
+	<properties>
+		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+	</properties>
 
 	<build>
 		<resources>

diff --git a/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/ClientFactory.java b/azure-servicebus/src/main/java/com/microsoft/azure/servicebus/ClientFactory.java
@@ -313,7 +313,7 @@ public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntit
      * @param namespaceName namespace of entity
      * @param entityPath path of entity
      * @param clientSettings client settings
-     * @param receiveMode
+     * @param receiveMode PeekLock or ReceiveAndDelete
      * @return a CompletableFuture representing the pending creation of message receiver
      */
     public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntityPathAsync(String namespaceName, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode) {
@@ -323,9 +323,9 @@ public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntit
 
     /**
      * Asynchronously creates a message receiver to the entity using the client settings in PeekLock mode
-     * @param namespaceEndpointURI
-     * @param entityPath
-     * @param clientSettings
+     * @param namespaceEndpointURI endpoint uri of entity namespace
+     * @param entityPath path of entity
+     * @param clientSettings client settings
      * @return a CompletableFuture representing the pending creation of message receiver
      */
     public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings) {
@@ -334,10 +334,10 @@ public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntit
 
     /**
      * Asynchronously creates a message receiver to the entity using the client settings
-     * @param namespaceEndpointURI
-     * @param entityPath
-     * @param clientSettings
-     * @param receiveMode
+     * @param namespaceEndpointURI endpoint uri of entity namespace
+     * @param entityPath path of entity
+     * @param clientSettings client settings
+     * @param receiveMode PeekLock or ReceiveAndDelete
      * @return a CompletableFuture representing the pending creation of message receiver
      */
     public static CompletableFuture<IMessageReceiver> createMessageReceiverFromEntityPathAsync(URI namespaceEndpointURI, String entityPath, ClientSettings clientSettings, ReceiveMode receiveMode) {