Skip to content
This repository was archived by the owner on Jul 19, 2024. It is now read-only.

Commit 4db7212

Browse files
JonathanGilesmirobers
authored andcommitted
Reduces the number of JavaDoc warnings from 89 to 3 in azure-storage-java (#244)
Reduces the number of JavaDoc warnings from 89 to 3 in azure-storage-…
1 parent 08b256e commit 4db7212

27 files changed

+47
-69
lines changed

microsoft-azure-storage/src/com/microsoft/azure/storage/AccessCondition.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -346,9 +346,6 @@ public void applySourceConditionToRequest(final HttpURLConnection request) {
346346
* @param request
347347
* A <code>java.net.HttpURLConnection</code> object that represents the request to which the condition is
348348
* being applied.
349-
*
350-
* @throws StorageException
351-
* If there is an error parsing the date value of the access condition.
352349
*/
353350
public void applyAppendConditionToRequest(final HttpURLConnection request) {
354351
if (this.ifMaxSizeLessThanOrEqual != null) {

microsoft-azure-storage/src/com/microsoft/azure/storage/LoggingProperties.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public final class LoggingProperties {
2727
private String version = "1.0";
2828

2929
/**
30-
* An <code>EnumSet<code> of <code>LoggingOperations</code> that represents which storage operations should be logged.
30+
* An <code>EnumSet</code> of <code>LoggingOperations</code> that represents which storage operations should be logged.
3131
*/
3232
private EnumSet<LoggingOperations> logOperationTypes = EnumSet.noneOf(LoggingOperations.class);
3333

@@ -37,9 +37,9 @@ public final class LoggingProperties {
3737
private Integer retentionIntervalInDays;
3838

3939
/**
40-
* Gets an <code>EnumSet<code> of <code>{@link LoggingOperations}</code> that represents which storage operations should be logged.
40+
* Gets an <code>EnumSet</code> of <code>{@link LoggingOperations}</code> that represents which storage operations should be logged.
4141
*
42-
* @return An <code>EnumSet<code> of <code>{@link LoggingOperations}</code>.
42+
* @return An <code>EnumSet</code> of <code>{@link LoggingOperations}</code>.
4343
*/
4444
public EnumSet<LoggingOperations> getLogOperationTypes() {
4545
return this.logOperationTypes;
@@ -67,7 +67,7 @@ public String getVersion() {
6767
* Sets the <code>{@link LoggingOperations}</code> for which storage operations should be logged.
6868
*
6969
* @param logOperationTypes
70-
* An <code>EnumSet<code> of <code>{@link LoggingOperations}</code> to set.
70+
* An <code>EnumSet</code> of <code>{@link LoggingOperations}</code> to set.
7171
*/
7272
public void setLogOperationTypes(final EnumSet<LoggingOperations> logOperationTypes) {
7373
this.logOperationTypes = logOperationTypes;

microsoft-azure-storage/src/com/microsoft/azure/storage/OperationContext.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ public OperationContext() {
186186
/**
187187
* Gets the client side trace ID.
188188
*
189-
* @return A <code>String</cod> which represents the client request ID.
189+
* @return A <code>String</code> which represents the client request ID.
190190
*/
191191
public String getClientRequestID() {
192192
return this.clientRequestID;

microsoft-azure-storage/src/com/microsoft/azure/storage/RetryInfo.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public RetryInfo() {
4545
}
4646

4747
/**
48-
* Initializes a new instance of the {@link "RetryInfo"} class.
48+
* Initializes a new instance of the {@link RetryInfo} class.
4949
*
5050
* @param retryContext
5151
* The {@link RetryContext} object that was passed in to the retry policy.
@@ -114,7 +114,7 @@ public void setUpdatedLocationMode(LocationMode updatedLocationMode) {
114114
}
115115

116116
/**
117-
* Returns a string that represents the current {@link "RetryInfo"} instance.
117+
* Returns a string that represents the current {@link RetryInfo} instance.
118118
*
119119
* @return A <code>String</code> which represents the current <code>RetryInfo</code> instance.
120120
*/

microsoft-azure-storage/src/com/microsoft/azure/storage/SharedAccessPolicyHandler.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,6 @@ private SharedAccessPolicyHandler(final Class<T> cls) {
5858
* @return the HashMap of SharedAccessPolicies from the response
5959
* @throws SAXException
6060
* @throws ParserConfigurationException
61-
* @throws ParseException
62-
* if a date is incorrectly encoded in the stream
6361
* @throws IOException
6462
*/
6563
public static <T extends SharedAccessPolicy> HashMap<String, T> getAccessIdentifiers(final InputStream stream,

microsoft-azure-storage/src/com/microsoft/azure/storage/analytics/CloudAnalyticsClient.java

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -385,9 +385,7 @@ public Iterable<LogRecord> listLogRecords(StorageService service, Date startTime
385385
* @param logBlobs
386386
* An {@link Iterable} of blobs to parse LogRecords from.
387387
* @return
388-
* An enumerable collection of objects that implement {@link LogRecords} and are retrieved lazily.
389-
* @throws StorageException
390-
* @throws URISyntaxException
388+
* An enumerable collection of objects that implement {@link LogRecord} and are retrieved lazily.
391389
*/
392390
public static Iterable<LogRecord> parseLogBlobs(Iterable<ListBlobItem> logBlobs) {
393391
Utility.assertNotNull("logBlobs", logBlobs);
@@ -398,12 +396,10 @@ public static Iterable<LogRecord> parseLogBlobs(Iterable<ListBlobItem> logBlobs)
398396
/**
399397
* Returns an enumerable collection of log records, retrieved lazily.
400398
*
401-
* @param logBlobs
402-
* An {@link Iterable} of blobs to parse LogRecords from.
399+
* @param logBlob
400+
* A single blob to parse LogRecords from.
403401
* @return
404-
* An enumerable collection of objects that implement {@link LogRecords} and are retrieved lazily.
405-
* @throws StorageException
406-
* @throws URISyntaxException
402+
* An enumerable collection of objects that implement {@link LogRecord} and are retrieved lazily.
407403
*/
408404
public static Iterable<LogRecord> parseLogBlob(ListBlobItem logBlob) {
409405
Utility.assertNotNull("logBlob", logBlob);

microsoft-azure-storage/src/com/microsoft/azure/storage/blob/BlobContainerProperties.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,10 @@ public LeaseDuration getLeaseDuration() {
108108
/**
109109
* Gets the public access level for the container.
110110
* This field should only be set using the container's {@link #create(BlobContainerPublicAccessType,
111-
* BlobRequestOptions, OperationContext) create} method or
111+
* BlobRequestOptions, com.microsoft.azure.storage.OperationContext) create} method or
112112
* {@link #uploadPermissions(BlobContainerPermissions) uploadPermissions} method.
113113
*
114-
* @return A <code>{@link BlobContainerPublicAccessLevel}</code> that specifies the level of public access
114+
* @return A <code>{@link BlobContainerPublicAccessType}</code> that specifies the level of public access
115115
* that is allowed on the container.
116116
*/
117117
public BlobContainerPublicAccessType getPublicAccess() {
@@ -171,7 +171,7 @@ protected void setLeaseDuration(final LeaseDuration leaseDuration) {
171171
/**
172172
* Sets the public access level on the container.
173173
* This should only be set using the container's {@link #create(BlobContainerPublicAccessType,
174-
* BlobRequestOptions, OperationContext) create} method or
174+
* BlobRequestOptions, com.microsoft.azure.storage.OperationContext) create} method or
175175
* {@link #uploadPermissions(BlobContainerPermissions) uploadPermissions} method.
176176
* @param publicAccess
177177
* A <code>{@link BlobContainerPublicAccessType}</code> object

microsoft-azure-storage/src/com/microsoft/azure/storage/blob/BlobInputStream.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ else if (numberOfBytesRead == 0) {
337337
* elements <code>b[0]</code> through <code>b[k-1]</code>, leaving elements <code>b[k]</code> through
338338
* <code>b[b.length-1]</code> unaffected.
339339
*
340-
* The <code>read(b) method for class {@link InputStream} has the same effect as:
340+
* The <code>read(b)</code> method for class {@link InputStream} has the same effect as:
341341
*
342342
* <code>read(b, 0, b.length)</code>
343343
*

microsoft-azure-storage/src/com/microsoft/azure/storage/blob/BlobProperties.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ public Date getLastModified() {
304304
/**
305305
* Gets a value indicating if the tier of the blob has been inferred.
306306
*
307-
* @return A {@Link java.lang.Boolean} object which represents if the blob tier was inferred.
307+
* @return A {@link java.lang.Boolean} object which represents if the blob tier was inferred.
308308
*/
309309
public Boolean isBlobTierInferred() { return this.isBlobTierInferredTier; }
310310

microsoft-azure-storage/src/com/microsoft/azure/storage/blob/CloudAppendBlob.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ public Long appendBlock(final InputStream sourceStream, final long length) throw
357357
* An {@link OperationContext} object which represents the context for the current operation. This object
358358
* is used to track requests to the storage service, and to provide additional runtime information about
359359
* the operation.
360-
* @return The offset at which the block was appended.</returns>
360+
* @return The offset at which the block was appended.
361361
* @throws IOException
362362
* If an I/O exception occurred.
363363
* @throws StorageException

0 commit comments

Comments
 (0)