Fix java doc errors and warning.

Co-authored-by: zxl01071856 <[email protected]>

Author: huiguangjun

pom.xml

@@ -182,10 +182,6 @@
                         <goals>
                             <goal>jar</goal>
                         </goals>
-                        <configuration>
-                            <!-- <additionalparam>-Xdoclint:none</additionalparam>  -->
-                            <additionalJOption>-Xdoclint:none</additionalJOption>
-                        </configuration>
                     </execution>
                 </executions>
             </plugin>

src/main/java/com/aliyun/oss/OSS.java

@@ -552,7 +552,6 @@ public interface OSS {
      *      <li>{@link BucketVersioningConfiguration#ENABLED}</li>
      *      <li>{@link BucketVersioningConfiguration#SUSPENDED}</li>
      *  </ul>
-     * </p>
      * <p>
      * By default, new buckets are in the
      * {@link BucketVersioningConfiguration#OFF off} state. Once versioning is
@@ -604,7 +603,6 @@ public interface OSS {
      *      <li>{@link BucketVersioningConfiguration#ENABLED}</li>
      *      <li>{@link BucketVersioningConfiguration#SUSPENDED}</li>
      *  </ul>
-     * </p>
      * <p>
      * By default, new buckets are in the
      * {@link BucketVersioningConfiguration#OFF off} state. Once versioning is
@@ -657,7 +655,6 @@ public BucketVersioningConfiguration getBucketVersioning(GenericRequest genericR
      *      <li>{@link BucketVersioningConfiguration#ENABLED}
      *      <li>{@link BucketVersioningConfiguration#SUSPENDED}
      *  </ul>
-     * </p>
      * <p>
      * By default, new buckets are in the
      * {@link BucketVersioningConfiguration#OFF off} state. Once versioning is
@@ -975,11 +972,10 @@ public VersionListing listVersions(String bucketName, String prefix)
      * If calling <code>listVersions</code> with
      * a <code>prefix</code> value of "foo/" and a <code>delimiter</code> value of "/"
      * on this bucket, a <code>VersionListing</code> is returned that contains:
-     * 	<ul>
-     * 		<li>all the versions for one key ("foo/boo")</li>
-     * 		<li>one entry in the common prefixes list ("foo/bar/")</li>
-     * 	</ul>
-     * </p>
+     * <ul>
+     * <li>all the versions for one key ("foo/boo")</li>
+     * <li>one entry in the common prefixes list ("foo/bar/")</li>
+     * </ul>
      * <p>
      * To see deeper into the virtual hierarchy, make
      * another call to <code>listVersions</code> setting the prefix parameter to any
@@ -1111,7 +1107,6 @@ public VersionListing listVersions(String bucketName, String prefix,
      *      <li>all the versions for one key ("foo/boo")</li>
      *      <li>one entry in the common prefixes list ("foo/bar/")</li>
      *  </ul>
-     * </p>
      * <p>
      * To see deeper into the virtual hierarchy, make
      * another call to <code>listVersions</code> setting the prefix parameter to any
@@ -1122,7 +1117,7 @@ public VersionListing listVersions(String bucketName, String prefix,
      * For more information about enabling versioning for a bucket, see
      * {@link #setBucketVersioning(SetBucketVersioningRequest)}.
      * </p>
-     * 
+     *
      * @param listVersionsRequest
      *            The request object containing all options for listing the
      *            versions in a specified bucket.
@@ -4247,6 +4242,7 @@ public String generateRtmpUri(GenerateRtmpUriRequest generatePushflowUrlRequest)
      * 
      * @param bucketName
      *             The bucket name.
+     * @return  A {@link GetBucketRequestPaymentResult} instance.
      * @throws OSSException
      *             If any errors are encountered in the client while making the
      *             request or handling the response.
@@ -4260,6 +4256,7 @@ public String generateRtmpUri(GenerateRtmpUriRequest generatePushflowUrlRequest)
      * 
      * @param genericRequest
      *             {@link GenericRequest} instance that has the bucket name.
+     * @return  A {@link GetBucketRequestPaymentResult} instance.
      * @throws OSSException
      *             If any errors are encountered in the client while making the
      *             request or handling the response.
@@ -4505,6 +4502,8 @@ public GetAsyncFetchTaskResult getAsyncFetchTask(GetAsyncFetchTaskRequest getAsy
     /**
      * Returns all {@link VpcPolicy} instances of the Bucket.
      *
+     * @param genericRequest
+     *              A {@link GenericRequest} instance that include the bucket name.
      * @return A list of {@link VpcPolicy} instances. If there's no list, the
      *         list will be empty (instead of null).
      * @throws OSSException
@@ -4915,6 +4914,7 @@ public DeleteDirectoryResult deleteDirectory(String bucketName, String dirName,
      * 
      * @param bucketName
      *             The bucket name.
+     * @return A {@link GetBucketResourceGroupResult} instance.
      * @throws OSSException
      *             If any errors are encountered in the client while making the
      *             request or handling the response.
@@ -5021,6 +5021,7 @@ public UdfApplicationLog getUdfApplicationLog(GetUdfApplicationLogRequest getUdf
      * @param bucketName
      *             The bucket name.
      * @param status
+     *             The bucket access monitor status.
      *
      * @return A {@link VoidResult} instance wrapped void return and
      *         contains some basic response options, such as requestId.
@@ -5077,6 +5078,7 @@ public UdfApplicationLog getUdfApplicationLog(GetUdfApplicationLogRequest getUdf
     /**
      * Query files that meet the specified criteria from the OSS Server
      * @param doMetaQueryRequest
+     *             The {@link DoMetaQueryRequest} instance
      * @return A {@link DoMetaQueryResult} instance.
      * @throws OSSException
      *             If any errors are encountered in the client while making the

src/main/java/com/aliyun/oss/OSSClient.java

@@ -77,22 +77,32 @@ public class OSSClient implements OSS {
     private OSSDownloadOperation downloadOperation;
     private LiveChannelOperation liveChannelOperation;
 
-    /**Gets the inner multipartOperation, used for subclass to do implement opreation.*/
+    /**Gets the inner multipartOperation, used for subclass to do implement opreation.
+     * @return  the {@link OSSMultipartOperation} instance.
+     */
     public OSSMultipartOperation getMultipartOperation() {
         return multipartOperation;
     }
 
-    /**Gets the inner objectOperation, used for subclass to do implement opreation.*/
+    /**Gets the inner objectOperation, used for subclass to do implement opreation.
+     * @return  the {@link OSSObjectOperation} instance.
+     */
     public OSSObjectOperation getObjectOperation() {
         return objectOperation;
     }
 
-    /**Sets the inner downloadOperation.*/
+    /**Sets the inner downloadOperation.
+     * @param downloadOperation
+     *            the {@link OSSDownloadOperation} instance.
+     */
     public void setDownloadOperation(OSSDownloadOperation downloadOperation) {
         this.downloadOperation = downloadOperation;
     }
 
-    /**Sets the inner uploadOperation.*/
+    /**Sets the inner uploadOperation.
+     * @param uploadOperation
+     *            the {@link OSSUploadOperation} instance.
+     */
     public void setUploadOperation(OSSUploadOperation uploadOperation) {
         this.uploadOperation = uploadOperation;
     }
@@ -515,9 +525,6 @@ public boolean doesBucketExist(GenericRequest genericRequest) throws OSSExceptio
         return bucketOperation.doesBucketExists(genericRequest);
     }
 
-    /**
-     * Deprecated. Please use {@link OSSClient#doesBucketExist(String)} instead.
-     */
     @Deprecated
     public boolean isBucketExist(String bucketName) throws OSSException, ClientException {
         return this.doesBucketExist(bucketName);

src/main/java/com/aliyun/oss/OSSEncryptionClient.java

@@ -223,10 +223,6 @@ public UploadPartCopyResult uploadPartCopy(UploadPartCopyRequest request) throws
 
     /**
      * Note: This method is disabled in encryption client.
-     *  
-     * @deprecated please use normal oss client method
-     *     {@link OSSClient}#putObject(URL signedUrl, InputStream requestContent, long contentLength,
-     *           Map<String, String> requestHeaders, boolean useChunkEncoding).
      */
     @Override
     @Deprecated

src/main/java/com/aliyun/oss/common/comm/HttpDeleteWithBody.java

@@ -35,9 +35,7 @@ public HttpDeleteWithBody(final URI uri) {
         setURI(uri);
     }
 
-    /**
-     * @throws IllegalArgumentException if the uri is invalid.
-     */
+    // throws IllegalArgumentException if the uri is invalid.
     public HttpDeleteWithBody(final String uri) {
         super();
         setURI(URI.create(uri));

src/main/java/com/aliyun/oss/common/utils/HttpUtil.java

@@ -37,9 +37,7 @@ public class HttpUtil {
     private static final String[] ENCODED_CHARACTERS_WITHOUT_SLASHES = new String[]{"+", "*", "%7E"};
     private static final String[] ENCODED_CHARACTERS_WITHOUT_SLASHES_REPLACEMENTS = new String[]{"%20", "%2A", "~"};
 
-    /**
-     * Encode a URL segment with special chars replaced.
-     */
+    // Encode a URL segment with special chars replaced.
     public static String urlEncode(String value, String encoding) {
         if (value == null) {
             return "";
@@ -80,9 +78,7 @@ public static String urlEncode(String value, boolean ignoreSlashes) {
         }
     }
 
-    /**
-     * Encode request parameters to URL segment.
-     */
+    // Encode request parameters to URL segment.
     public static String paramToQueryString(Map<String, String> params, String charset) {
 
         if (params == null || params.isEmpty()) {

src/main/java/com/aliyun/oss/crypto/ContentCryptoMaterialRW.java

@@ -30,48 +30,69 @@
 public class ContentCryptoMaterialRW extends ContentCryptoMaterial {
     /**
      * Sets the content crypto algorithm to the specified algorithm.
+     *
+     * @param cententCryptoAlgorithm
+     *            crypto algorithm.
      */
     public void setContentCryptoAlgorithm(String cententCryptoAlgorithm) {
         this.contentCryptoAlgorithm = cententCryptoAlgorithm;
     }
 
     /**
      * Sets the content encryption key to the specified key.
+     *
+     * @param cek
+     *            secret key.
      */
     public void setCEK(SecretKey cek) {
         this.cek = cek;
     }
 
     /**
      * Sets the content crypto cipher start counter to the specified counter.
+     *
+     * @param iv
+     *            initialize vector.
      */
     public void setIV(byte[] iv) {
         this.iv = iv;
     }
 
     /**
      * Sets the encrypted content encryption key to the specified array.
+     *
+     * @param encryptedCEK
+     *            encrypted secret key.
      */
     public void setEncryptedCEK(byte[] encryptedCEK) {
         this.encryptedCEK = encryptedCEK.clone();
     }
 
     /**
      * Sets the encrypted content crypto cipher start counter to the specified array.
+     *
+     * @param encryptedIV
+     *            encrypted initialize vector.
      */
     public void setEncryptedIV(byte[] encryptedIV) {
         this.encryptedIV = encryptedIV.clone();
     }
 
     /**
      * Sets the key wrap algorithm to the specified algorithm.
+     *
+     * @param keyWrapAlgorithm
+     *            key wrap algorithm.
      */
     public void setKeyWrapAlgorithm(String keyWrapAlgorithm) {
         this.keyWrapAlgorithm = keyWrapAlgorithm;
     }
 
     /**
      * Sets the description of the encryption materials
+     *
+     * @param matdesc
+     *            description of the encryption materials.
      */
     public void setMaterialsDescription(Map<String, String> matdesc) {
         this.matdesc = Collections.unmodifiableMap(new TreeMap<String, String>(matdesc));