Merge pull request #871 from anuchandy/apidocfix

couple of javadoc fixes
Azure · Jun 21, 2016 · 38f69fe · 38f69fe
2 parents 47154cc + 1c5e137
commit 38f69fe
Show file tree

Hide file tree

Showing 7 changed files with 46 additions and 34 deletions.
diff --git a/azure-mgmt-compute/src/main/java/com/microsoft/azure/management/compute/VirtualMachine.java b/azure-mgmt-compute/src/main/java/com/microsoft/azure/management/compute/VirtualMachine.java
@@ -259,9 +259,9 @@ public interface VirtualMachine extends
      */
     DiagnosticsProfile diagnosticsProfile();
 
-   /**
-    * @return the power state of the virtual machine
-    */
+    /**
+     * @return the power state of the virtual machine
+     */
     PowerState powerState();
 
     /**
@@ -372,7 +372,7 @@ interface DefinitionWithPublicIpAddress {
          * @param creatable a creatable definition for a new public IP
          * @return the next stage of the virtual machine definition
          */
-         DefinitionWithOS withNewPrimaryPublicIpAddress(PublicIpAddress.DefinitionCreatable creatable);
+        DefinitionWithOS withNewPrimaryPublicIpAddress(PublicIpAddress.DefinitionCreatable creatable);
 
         /**
          * Creates a new public IP address in the same region and group as the resource, with the specified DNS label
@@ -498,7 +498,8 @@ interface DefinitionWithOS {
         /**
          * Specifies the specialized operating system disk to be attached to the virtual machine.
          *
-         * @param osDiskUrl the url to the OS disk in the Azure Storage account
+         * @param osDiskUrl osDiskUrl the url to the OS disk in the Azure Storage account
+         * @param osType the OS type
          * @return the next stage of the Windows virtual machine definition
          */
         DefinitionCreatable withOsDisk(String osDiskUrl, OperatingSystemTypes osType);
@@ -538,8 +539,8 @@ interface DefinitionWithAdminUserName {
     interface DefinitionLinuxCreatable extends DefinitionCreatable {
         /**
          * Specifies the SSH public key.
-         * <p/>
-         * each call to this method adds the given public key to the list of VM's public keys.
+         * <p>
+         * Each call to this method adds the given public key to the list of VM's public keys.
          *
          * @param publicKey the SSH public key in PEM format.
          * @return the stage representing creatable Linux VM definition
@@ -570,15 +571,17 @@ interface DefinitionWindowsCreatable extends DefinitionCreatable {
         /**
          * Specifies the time-zone.
          *
+         * @param timeZone the timezone
          * @return the stage representing creatable Windows VM definition
          */
         DefinitionWindowsCreatable withTimeZone(String timeZone);
 
         /**
          * Specifies the WINRM listener.
-         * <p/>
+         * <p>
          * Each call to this method adds the given listener to the list of VM's WinRM listeners.
          *
+         * @param listener the WinRmListener
          * @return the stage representing creatable Windows VM definition
          */
         DefinitionWindowsCreatable withWinRm(WinRMListener listener);

diff --git a/azure-mgmt-network/src/main/java/com/microsoft/azure/management/network/Network.java b/azure-mgmt-network/src/main/java/com/microsoft/azure/management/network/Network.java
@@ -137,8 +137,8 @@ interface UpdateWithSubnet {
      * the resource to be created (via {@link DefinitionCreatable#create()}), but also allows
      * for any other optional settings to be specified, except for adding subnets.
      * <p>
-     * Subnets can be added only right after the address space is explicitly specified
-     * (see {@link DefinitionWithAddressSpace#withAddressSpace(String)).
+     * A subnet can be added only right after the address space is explicitly specified
+     * see {@link DefinitionCreatable#withAddressSpace }
      */
     interface DefinitionCreatable extends
         Creatable<Network>,

diff --git a/...e-mgmt-network/src/main/java/com/microsoft/azure/management/network/NetworkInterface.java b/...e-mgmt-network/src/main/java/com/microsoft/azure/management/network/NetworkInterface.java
@@ -340,6 +340,7 @@ interface DefinitionCreatable extends
         /**
          * Starts definition of a secondary Ip configuration.
          *
+         * @param name name for the Ip configuration
          * @return the first stage of a secondary Ip configuration definition
          */
         NicIpConfiguration.DefinitionBlank<DefinitionCreatable> defineSecondaryIpConfiguration(String name);
@@ -499,13 +500,15 @@ interface Update extends
         /**
          * Starts definition of a secondary Ip configuration.
          *
+         * @param name name for the Ip configuration
          * @return the first stage of a secondary Ip configuration definition
          */
         NicIpConfiguration.DefinitionBlank<NetworkInterface.Update> defineSecondaryIpConfiguration(String name);
 
         /**
          * Starts update of an Ip configuration.
          *
+         * @param name name of the Ip configuration
          * @return the first stage of an Ip configuration update
          */
         NicIpConfiguration.Update<NetworkInterface.Update> updateIpConfiguration(String name);

diff --git a/...gmt-network/src/main/java/com/microsoft/azure/management/network/NetworkSecurityRule.java b/...gmt-network/src/main/java/com/microsoft/azure/management/network/NetworkSecurityRule.java
@@ -163,7 +163,7 @@ public static Protocol fromString(String s) {
 
     /**
      * The entirety of a network security rule definition.
-     * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+     * @param <ParentT> the return type of the final {@link Attachable#attach()}
      */
     interface Definition<ParentT> extends
         Definables.Blank<ParentT>,
@@ -178,7 +178,7 @@ interface Definition<ParentT> extends
 
     /**
      * The entirety of a network security rule definition as part of a network security group update.
-     * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+     * @param <ParentT> the return type of the final {@link Attachable#attach()}
      */
     interface UpdateDefinition<ParentT> extends
         UpdateDefinables.Blank<ParentT>,
@@ -360,14 +360,14 @@ interface WithProtocol {
     interface UpdateDefinables {
         /**
          * The first stage of a security rule description as part of an update of a networking security group.
-         * @param <ParentT> the return type of the final {@link UpdateDefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface Blank<ParentT> extends WithDirectionAccess<ParentT> {
         }
 
         /**
          * The stage of the network rule definition allowing the direction and the access type to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithDirectionAccess<ParentT> {
             /**
@@ -397,7 +397,7 @@ interface WithDirectionAccess<ParentT> {
 
         /**
          * The stage of the network rule definition allowing the source address to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithSourceAddress<ParentT> {
             /**
@@ -416,7 +416,7 @@ interface WithSourceAddress<ParentT> {
 
         /**
          * The stage of the network rule definition allowing the source port(s) to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithSourcePort<ParentT> {
             /**
@@ -443,7 +443,7 @@ interface WithSourcePort<ParentT> {
 
         /**
          * The stage of the network rule definition allowing the destination address to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithDestinationAddress<ParentT> {
             /**
@@ -462,7 +462,7 @@ interface WithDestinationAddress<ParentT> {
 
         /**
          * The stage of the network rule definition allowing the destination port(s) to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithDestinationPort<ParentT> {
             /**
@@ -489,7 +489,7 @@ interface WithDestinationPort<ParentT> {
 
         /**
          * The stage of the security rule definition allowing the protocol that the rule applies to to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithProtocol<ParentT> {
             /**
@@ -531,14 +531,14 @@ interface WithAttach<ParentT> extends Attachable.InUpdate<ParentT> {
     interface Definables {
         /**
          * The first stage of a security rule definition.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface Blank<ParentT> extends WithDirectionAccess<ParentT> {
         }
 
         /**
          * The stage of the security rule definition allowing the protocol that the rule applies to to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithProtocol<ParentT> {
             /**
@@ -557,7 +557,7 @@ interface WithProtocol<ParentT> {
 
         /**
          * The stage of the network rule definition allowing the destination port(s) to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithDestinationPort<ParentT> {
             /**
@@ -584,7 +584,7 @@ interface WithDestinationPort<ParentT> {
 
         /**
          * The stage of the network rule definition allowing the destination address to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithDestinationAddress<ParentT> {
             /**
@@ -603,7 +603,8 @@ interface WithDestinationAddress<ParentT> {
 
         /**
          * The stage of the network rule definition allowing the source port(s) to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         *
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithSourcePort<ParentT> {
             /**
@@ -630,7 +631,7 @@ interface WithSourcePort<ParentT> {
 
         /**
          * The stage of the network rule definition allowing the source address to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithSourceAddress<ParentT> {
             /**
@@ -649,7 +650,7 @@ interface WithSourceAddress<ParentT> {
 
         /**
          * The stage of the network rule definition allowing the direction and the access type to be specified.
-         * @param <ParentT> the return type of the final {@link DefinitionAttachable#attach()}
+         * @param <ParentT> the return type of the final {@link Attachable#attach()}
          */
         interface WithDirectionAccess<ParentT> {
             /**

diff --git a/azure-mgmt-resources/src/main/java/com/microsoft/azure/management/resources/Deployment.java b/azure-mgmt-resources/src/main/java/com/microsoft/azure/management/resources/Deployment.java
@@ -158,6 +158,7 @@ interface DefinitionWithTemplate {
          *
          * @param templateJson the JSON string
          * @return the next stage of the deployment definition
+         * @throws IOException exception thrown from serialization/deserialization
          */
         DefinitionWithParameters withTemplate(String templateJson) throws IOException;
 
@@ -185,9 +186,9 @@ interface DefinitionWithParameters {
 
         /**
          * Specifies the parameters as a JSON string.
-         *
          * @param parametersJson the JSON string
          * @return the next stage of the deployment definition
+         * @throws IOException exception thrown from serialization/deserialization
          */
         DefinitionWithMode withParameters(String parametersJson) throws IOException;
 
@@ -253,6 +254,7 @@ interface UpdateWithTemplate {
          *
          * @param templateJson the JSON string
          * @return the next stage of the deployment update
+         * @throws IOException exception thrown from serialization/deserialization
          */
         Update withTemplate(String templateJson) throws IOException;
 
@@ -283,6 +285,7 @@ interface UpdateWithParameters {
          *
          * @param parametersJson the JSON string
          * @return the next stage of the deployment update
+         * @throws IOException exception thrown from serialization/deserialization
          */
         Update withParameters(String parametersJson) throws IOException;
 

diff --git a/...gmt-resources/src/main/java/com/microsoft/azure/management/resources/GenericResource.java b/...gmt-resources/src/main/java/com/microsoft/azure/management/resources/GenericResource.java
@@ -214,6 +214,7 @@ interface UpdateWithApiVersion {
         /**
          * Specifies the API version of the resource provider.
          *
+         * @param apiVersion the API version
          * @return the next stage of the generic resource update
          */
         Update withApiVersion(String apiVersion);

diff --git a/...entication/src/main/java/com/microsoft/azure/credentials/ApplicationTokenCredentials.java b/...entication/src/main/java/com/microsoft/azure/credentials/ApplicationTokenCredentials.java
@@ -113,13 +113,14 @@ public ApplicationTokenCredentials withDefaultSubscriptionId(String subscription
      *
      * @param credentialsFile A  file with credentials, using the standard Java properties format.
      * and the following keys:
-         *     subscription=<subscription-id>
-         *     tenant=<tenant-id>
-         *     client=<client-id>
-         *     key=<client-key>
-         *     managementURI=<management-URI>
-         *     baseURL=<base-URL>
-         *     authURL=<authentication-URL>
+     *     subscription=&lt;subscription-id&gt;
+     *     tenant=&lt;tenant-id&gt;
+     *     client=&lt;client-id&gt;
+     *     key=&lt;client-key&gt;
+     *     managementURI=&lt;management-URI&gt;
+     *     baseURL=&lt;base-URL&gt;
+     *     authURL=&lt;authentication-URL&gt;
+     *
      * @return The credentials based on the file.
      * @throws IOException exception thrown from file access errors.
      */