From c5a943c3606ffee2c310bd33b7c52533b41edcec Mon Sep 17 00:00:00 2001 From: anuchan Date: Tue, 21 Jun 2016 12:46:20 -0700 Subject: [PATCH 1/2] couple of javadoc fixes --- .../management/compute/VirtualMachine.java | 19 ++++++----- .../azure/management/network/Network.java | 4 +-- .../management/network/NetworkInterface.java | 3 ++ .../network/NetworkSecurityRule.java | 33 ++++++++++--------- .../management/resources/Deployment.java | 7 ++-- .../management/resources/GenericResource.java | 1 + .../ApplicationTokenCredentials.java | 15 +++++---- 7 files changed, 47 insertions(+), 35 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 index 4ff3151235950..2165b380f7218 100644 --- 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,7 +539,7 @@ interface DefinitionWithAdminUserName { interface DefinitionLinuxCreatable extends DefinitionCreatable { /** * Specifies the SSH public key. - *

+ *

* 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. @@ -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. - *

- * Each call to this method adds the given listener to the list of VM's WinRM listeners. + *

+ * 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 index ab381272f180b..2bd227e093568 100644 --- 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. *

- * Subnets can be added only right after the address space is explicitly specified - * (see {@link DefinitionWithAddressSpace#withAddressSpace(String)). + * Subnet can be added only right after the address space is explicitly specified + * see {@link DefinitionCreatable#withAddressSpace } */ interface DefinitionCreatable extends Creatable, diff --git a/azure-mgmt-network/src/main/java/com/microsoft/azure/management/network/NetworkInterface.java b/azure-mgmt-network/src/main/java/com/microsoft/azure/management/network/NetworkInterface.java index b94338790b850..04adc26958475 100644 --- a/azure-mgmt-network/src/main/java/com/microsoft/azure/management/network/NetworkInterface.java +++ b/azure-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 defineSecondaryIpConfiguration(String name); @@ -499,6 +500,7 @@ 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 defineSecondaryIpConfiguration(String name); @@ -506,6 +508,7 @@ interface Update extends /** * Starts update of an Ip configuration. * + * @param name name of the Ip configuration * @return the first stage of an Ip configuration update */ NicIpConfiguration.Update updateIpConfiguration(String name); diff --git a/azure-mgmt-network/src/main/java/com/microsoft/azure/management/network/NetworkSecurityRule.java b/azure-mgmt-network/src/main/java/com/microsoft/azure/management/network/NetworkSecurityRule.java index 50d2791314854..45d3af6180797 100644 --- a/azure-mgmt-network/src/main/java/com/microsoft/azure/management/network/NetworkSecurityRule.java +++ b/azure-mgmt-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 the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface Definition extends Definables.Blank, @@ -178,7 +178,7 @@ interface Definition extends /** * The entirety of a network security rule definition as part of a network security group update. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface UpdateDefinition extends UpdateDefinables.Blank, @@ -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 the return type of the final {@link UpdateDefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface Blank extends WithDirectionAccess { } /** * The stage of the network rule definition allowing the direction and the access type to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithDirectionAccess { /** @@ -397,7 +397,7 @@ interface WithDirectionAccess { /** * The stage of the network rule definition allowing the source address to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithSourceAddress { /** @@ -416,7 +416,7 @@ interface WithSourceAddress { /** * The stage of the network rule definition allowing the source port(s) to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithSourcePort { /** @@ -443,7 +443,7 @@ interface WithSourcePort { /** * The stage of the network rule definition allowing the destination address to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithDestinationAddress { /** @@ -462,7 +462,7 @@ interface WithDestinationAddress { /** * The stage of the network rule definition allowing the destination port(s) to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithDestinationPort { /** @@ -489,7 +489,7 @@ interface WithDestinationPort { /** * The stage of the security rule definition allowing the protocol that the rule applies to to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithProtocol { /** @@ -531,14 +531,14 @@ interface WithAttach extends Attachable.InUpdate { interface Definables { /** * The first stage of a security rule definition. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface Blank extends WithDirectionAccess { } /** * The stage of the security rule definition allowing the protocol that the rule applies to to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithProtocol { /** @@ -557,7 +557,7 @@ interface WithProtocol { /** * The stage of the network rule definition allowing the destination port(s) to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithDestinationPort { /** @@ -584,7 +584,7 @@ interface WithDestinationPort { /** * The stage of the network rule definition allowing the destination address to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithDestinationAddress { /** @@ -603,7 +603,8 @@ interface WithDestinationAddress { /** * The stage of the network rule definition allowing the source port(s) to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * + * @param the return type of the final {@link Attachable#attach()} */ interface WithSourcePort { /** @@ -630,7 +631,7 @@ interface WithSourcePort { /** * The stage of the network rule definition allowing the source address to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithSourceAddress { /** @@ -649,7 +650,7 @@ interface WithSourceAddress { /** * The stage of the network rule definition allowing the direction and the access type to be specified. - * @param the return type of the final {@link DefinitionAttachable#attach()} + * @param the return type of the final {@link Attachable#attach()} */ interface WithDirectionAccess { /** 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 index e2bc6438c14f4..8229d42993a70 100644 --- 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; @@ -282,7 +284,8 @@ interface UpdateWithParameters { * Specifies the parameters as a JSON string. * * @param parametersJson the JSON string - * @return the next stage of the deployment update + * @return the next stage of the deployment updateurn + * @throws IOException exception thrown from serialization/deserialization */ Update withParameters(String parametersJson) throws IOException; diff --git a/azure-mgmt-resources/src/main/java/com/microsoft/azure/management/resources/GenericResource.java b/azure-mgmt-resources/src/main/java/com/microsoft/azure/management/resources/GenericResource.java index 67168e3ab95e0..cdc5f8d79db33 100644 --- a/azure-mgmt-resources/src/main/java/com/microsoft/azure/management/resources/GenericResource.java +++ b/azure-mgmt-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/runtimes/azure-client-authentication/src/main/java/com/microsoft/azure/credentials/ApplicationTokenCredentials.java b/runtimes/azure-client-authentication/src/main/java/com/microsoft/azure/credentials/ApplicationTokenCredentials.java index 163d10f60a1d5..384ab3f7671af 100644 --- a/runtimes/azure-client-authentication/src/main/java/com/microsoft/azure/credentials/ApplicationTokenCredentials.java +++ b/runtimes/azure-client-authentication/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= - * tenant= - * client= - * key= - * managementURI= - * baseURL= - * authURL= + * subscription=<subscription-id> + * tenant=<tenant-id> + * client=<client-id> + * key=<client-key> + * managementURI=<management-URI> + * baseURL=<base-URL> + * authURL=<authentication-URL> + * * @return The credentials based on the file. * @throws IOException exception thrown from file access errors. */ From 1c5e137747ba3733fd3ea711e4e8e9365ceb23ab Mon Sep 17 00:00:00 2001 From: anuchan Date: Tue, 21 Jun 2016 13:42:16 -0700 Subject: [PATCH 2/2] addressing review comments --- .../microsoft/azure/management/compute/VirtualMachine.java | 4 ++-- .../java/com/microsoft/azure/management/network/Network.java | 2 +- .../com/microsoft/azure/management/resources/Deployment.java | 2 +- 3 files changed, 4 insertions(+), 4 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 index 2165b380f7218..3dfd89d65cd5c 100644 --- 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 @@ -540,7 +540,7 @@ interface DefinitionLinuxCreatable extends DefinitionCreatable { /** * Specifies the SSH public key. *

- * each call to this method adds the given public key to the list of VM's public keys. + * 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 @@ -579,7 +579,7 @@ interface DefinitionWindowsCreatable extends DefinitionCreatable { /** * Specifies the WINRM listener. *

- * Each call to this method adds the given listener to the list of VM's WinRM listeners + * 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 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 index 2bd227e093568..38f0fc8bcf68c 100644 --- 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,7 +137,7 @@ 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. *

- * Subnet can be added only right after the address space is explicitly specified + * A subnet can be added only right after the address space is explicitly specified * see {@link DefinitionCreatable#withAddressSpace } */ interface DefinitionCreatable extends 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 index 8229d42993a70..de9487997de58 100644 --- 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 @@ -284,7 +284,7 @@ interface UpdateWithParameters { * Specifies the parameters as a JSON string. * * @param parametersJson the JSON string - * @return the next stage of the deployment updateurn + * @return the next stage of the deployment update * @throws IOException exception thrown from serialization/deserialization */ Update withParameters(String parametersJson) throws IOException;