From 84c47af642961294216b11e7b74de8903a83e5c9 Mon Sep 17 00:00:00 2001 From: "Jason Cooke (MSFT)" Date: Wed, 23 Jan 2013 09:27:36 -0800 Subject: [PATCH] Fix JavaDoc build warnings --- .../services/blob/client/BlobContainerProperties.java | 4 ++-- .../windowsazure/services/blob/client/BlobProperties.java | 4 ++-- .../windowsazure/services/blob/client/CloudBlob.java | 6 +----- .../blob/core/storage/SharedAccessSignatureHelper.java | 8 ++------ .../services/blob/models/CreateBlobOptions.java | 2 +- .../services/blob/models/CreateBlobResult.java | 2 +- .../services/media/entityoperations/EntityOperation.java | 1 - .../windowsazure/services/media/models/ContentKey.java | 4 ++-- .../services/queue/client/SharedAccessQueuePolicy.java | 2 +- .../services/table/client/SharedAccessTablePolicy.java | 2 +- 10 files changed, 13 insertions(+), 22 deletions(-) diff --git a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/BlobContainerProperties.java b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/BlobContainerProperties.java index 2b781912d584b..516183818f699 100644 --- a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/BlobContainerProperties.java +++ b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/BlobContainerProperties.java @@ -131,7 +131,7 @@ public void setLeaseStatus(final LeaseStatus leaseStatus) { /** * Sets the lease status on the container. Reserved for internal use. * - * @param LeaseState + * @param leaseState * The lease state to set, as a LeaseState object. */ public void setLeaseState(final LeaseState leaseState) { @@ -141,7 +141,7 @@ public void setLeaseState(final LeaseState leaseState) { /** * Sets the lease duration on the container. Reserved for internal use. * - * @param LeaseDuration + * @param leaseDuration * The lease duration to set, as a LeaseDuration object. */ public void setLeaseDuration(final LeaseDuration leaseDuration) { diff --git a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/BlobProperties.java b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/BlobProperties.java index 9fc4475b052da..0eaff8e5789a4 100644 --- a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/BlobProperties.java +++ b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/BlobProperties.java @@ -334,7 +334,7 @@ public void setLeaseStatus(final LeaseStatus leaseStatus) { /** * Sets the lease state for the blob. Reserved for internal use. * - * @param LeaseState + * @param leaseState * The lease state to set, represented by a LeaseState object. */ public void setLeaseState(final LeaseState leaseState) { @@ -344,7 +344,7 @@ public void setLeaseState(final LeaseState leaseState) { /** * Sets the lease duration for the blob. Reserved for internal use. * - * @param LeaseDuration + * @param leaseDuration * The lease duration value to set, represented by a LeaseDuration object. */ public void setLeaseDuration(final LeaseDuration leaseDuration) { diff --git a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/CloudBlob.java b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/CloudBlob.java index 49ae8c7366fa7..585c5cb8da14d 100644 --- a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/CloudBlob.java +++ b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/client/CloudBlob.java @@ -1247,7 +1247,7 @@ public final void downloadRange(final long offset, final int length, final byte[ * the number of bytes to read * @param buffer * the byte buffer to write to. - * @param bufferOffet + * @param bufferOffset * the offset in the byte buffer to begin writing. * @param accessCondition * An {@link AccessCondition} object that represents the access conditions for the blob. @@ -1468,10 +1468,6 @@ else if (this.getResult().getStatusCode() == HttpURLConnection.HTTP_NOT_FOUND) { * signature. * @param groupPolicyIdentifier * A String that represents the container-level access policy. - * @param opContext - * An {@link OperationContext} object that represents the context for the current operation. This object - * is used to track requests to the storage service, and to provide additional runtime information about - * the operation. * * @return A String that represents the shared access signature. * diff --git a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/core/storage/SharedAccessSignatureHelper.java b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/core/storage/SharedAccessSignatureHelper.java index 9be65bdcb88f6..f798b48382329 100644 --- a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/core/storage/SharedAccessSignatureHelper.java +++ b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/core/storage/SharedAccessSignatureHelper.java @@ -149,10 +149,6 @@ public static UriQueryBuilder generateSharedAccessSignature(final SharedAccessQu /** * Get the complete query builder for creating the Shared Access Signature query. * - * @param policy - * The shared access policy to hash. - * @param groupPolicyIdentifier - * An optional identifier for the policy. * @param signature * The signature to use. * @return The finished query builder @@ -285,7 +281,7 @@ public static String generateSharedAccessSignatureHash(final SharedAccessBlobPol * * @param policy * The shared access policy to hash. - * @param groupPolicyIdentifier + * @param accessPolicyIdentifier * An optional identifier for the policy. * @param resourceName * the resource name. @@ -356,7 +352,7 @@ public static String generateSharedAccessSignatureHash(final String permissions, * * @param policy * The shared access policy to hash. - * @param groupPolicyIdentifier + * @param accessPolicyIdentifier * An optional identifier for the policy. * @param resourceName * the resource name. diff --git a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/models/CreateBlobOptions.java b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/models/CreateBlobOptions.java index 644f5e7b4718f..44e3e63090b45 100644 --- a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/models/CreateBlobOptions.java +++ b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/models/CreateBlobOptions.java @@ -20,7 +20,7 @@ /** * Represents the options that may be set on a - * {@link BlobContract#createPageBlob(String, String, int, CreateBlobOptions) createPageBlob} or + * {@link BlobContract#createPageBlob(String, String, long, CreateBlobOptions) createPageBlob} or * {@link BlobContract#createBlockBlob(String, String, java.io.InputStream, CreateBlobOptions) createBlockBlob} request. * These options include an optional server timeout for the operation, the MIME content type and content encoding for * the blob, the content language, the MD5 hash, a cache control value, blob metadata, a blob lease ID, a sequence diff --git a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/models/CreateBlobResult.java b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/models/CreateBlobResult.java index 6181e7c7278f7..57a4c0faebce1 100644 --- a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/models/CreateBlobResult.java +++ b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/blob/models/CreateBlobResult.java @@ -21,7 +21,7 @@ /** * A wrapper class for the response returned from a Blob Service REST API Create Blob operation. This is returned by * calls to implementations of {@link BlobContract#createPageBlob(String, String, long, CreateBlobOptions)} and - * {@link BlobContract#createBlockBlob(String, String, long, CreateBlobOptions)}. + * {@link BlobContract#createBlockBlob(String, String, java.io.InputStream, CreateBlobOptions)}. *

* See the Put Blob documentation on * MSDN for details of the underlying Blob Service REST API operation. diff --git a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/media/entityoperations/EntityOperation.java b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/media/entityoperations/EntityOperation.java index 6ac4b38c6f08f..1670581609e72 100644 --- a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/media/entityoperations/EntityOperation.java +++ b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/media/entityoperations/EntityOperation.java @@ -25,7 +25,6 @@ public interface EntityOperation { * Supplies the current proxy information to the action. * * @param proxyData - * @return */ public void setProxyData(EntityProxyData proxyData); diff --git a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/media/models/ContentKey.java b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/media/models/ContentKey.java index 4d93a5e773567..fea8d2ba62e2b 100644 --- a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/media/models/ContentKey.java +++ b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/media/models/ContentKey.java @@ -172,7 +172,7 @@ public Creator setProtectionKeyType(ProtectionKeyType protectionKeyType) { /** * Create an operation that will retrieve the given content key. * - * @param ContentKeyId + * @param contentKeyId * id of content key to retrieve * @return the operation */ @@ -205,7 +205,7 @@ public static DefaultListOperation list(LinkInfo /** * Create an operation to delete the given content key. * - * @param ContentKeyId + * @param contentKeyId * id of content key to delete * @return the delete operation */ diff --git a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/queue/client/SharedAccessQueuePolicy.java b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/queue/client/SharedAccessQueuePolicy.java index cd6b9085b4de7..77ffca21efd7b 100644 --- a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/queue/client/SharedAccessQueuePolicy.java +++ b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/queue/client/SharedAccessQueuePolicy.java @@ -75,7 +75,7 @@ public static EnumSet permissionsFromString(final * A {@link SharedAccessQueuePermissions} object that represents the shared access permissions. * * @return A String that represents the shared access permissions in the "rwdl" format, which is - * described at {@link SharedAccessQueuePermissions#permissionsFromString}. + * described at {@link SharedAccessQueuePolicy#permissionsFromString(String)}. */ public static String permissionsToString(final EnumSet permissions) { if (permissions == null) { diff --git a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/table/client/SharedAccessTablePolicy.java b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/table/client/SharedAccessTablePolicy.java index fbeb55dae5be7..4bca919332cac 100644 --- a/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/table/client/SharedAccessTablePolicy.java +++ b/microsoft-azure-api/src/main/java/com/microsoft/windowsazure/services/table/client/SharedAccessTablePolicy.java @@ -75,7 +75,7 @@ public static EnumSet permissionsFromString(final * A set of {@link SharedAccessTablePermissions} objects that represent the shared access permissions. * * @return A String that represents the shared access permissions in the "rwdl" format, which is - * described at {@link SharedAccessTablePermissions#permissionsFromString}. + * described at {@link SharedAccessTablePolicy#permissionsFromString(String)}. */ public static String permissionsToString(final EnumSet permissions) { if (permissions == null) {