update comments

Author: RuiboZhang1

pom.xml

@@ -270,9 +270,6 @@
 						<goals>
 							<goal>jar</goal>
 						</goals>
-						<configuration>
-							<additionalparam>-Xdoclint:none</additionalparam>
-						</configuration>
 					</execution>
 				</executions>
 			</plugin>

src/main/java/cn/jpush/api/JPushClient.java

@@ -950,12 +950,13 @@ public DefaultResult bindMobile(String registrationId, String mobile)
     }
 
     // ----------------------- Schedule
-
     /**
      * Create a single schedule.
      * @param name The schedule name.
      * @param time The push time, format is 'yyyy-MM-dd HH:mm:ss'
      * @param push The push payload.
+     * @param masterSecret master secret
+     * @param appKey app key
      * @return The created scheduleResult instance.
      * @throws APIConnectionException if a remote or network exception occurs.
      * @throws APIRequestException if a request exception occurs.
@@ -983,6 +984,8 @@ public ScheduleResult createSingleSchedule(String name, String time, PushPayload
      * @param end The schedule expiration date, format 'yyyy-MM-dd HH:mm:ss'.
      * @param time The push time, format 'HH:mm:ss'
      * @param push The push payload.
+     * @param masterSecret master secret
+     * @param appKey app key
      * @return The created scheduleResult instance.
      * @throws APIConnectionException if a remote or network exception occurs.
      * @throws APIRequestException if a request exception occurs.
@@ -1002,6 +1005,8 @@ public ScheduleResult createDailySchedule(String name, String start, String end,
      * @param time The push time, format 'HH:mm:ss'
      * @param frequency The custom frequency.
      * @param push The push payload.
+     * @param masterSecret master secret
+     * @param appKey app key
      * @return The created scheduleResult instance.
      * @throws APIConnectionException if a remote or network exception occurs.
      * @throws APIRequestException if a request exception occurs.
@@ -1021,6 +1026,8 @@ public ScheduleResult createDailySchedule(String name, String start, String end,
      * @param time The push time, format 'HH:mm:ss'
      * @param days The appointed days.
      * @param push The push payload.
+     * @param masterSecret master secret
+     * @param appKey app key
      * @return The created scheduleResult instance.
      * @throws APIConnectionException if a remote or network exception occurs.
      * @throws APIRequestException if a request exception occurs.
@@ -1047,6 +1054,8 @@ public ScheduleResult createWeeklySchedule(String name, String start, String end
      * @param frequency The custom frequency.
      * @param days The appointed days.
      * @param push The push payload.
+     * @param masterSecret master secret
+     * @param appKey app key
      * @return The created scheduleResult instance.
      * @throws APIConnectionException if a remote or network exception occurs.
      * @throws APIRequestException if a request exception occurs.
@@ -1071,6 +1080,8 @@ public ScheduleResult createWeeklySchedule(String name, String start, String end
      * @param time The push time, format 'HH:mm:ss'.
      * @param points The appointed days.
      * @param push The push payload.
+     * @param masterSecret master secret
+     * @param appKey app key
      * @return The created scheduleResult instance.
      * @throws APIConnectionException if a remote or network exception occurs.
      * @throws APIRequestException if a request exception occurs.
@@ -1091,6 +1102,8 @@ public ScheduleResult createMonthlySchedule(String name, String start, String en
      * @param frequency The custom frequency.
      * @param points The appointed days.
      * @param push The push payload.
+     * @param masterSecret master secret
+     * @param appKey app key
      * @return The created scheduleResult instance.
      * @throws APIConnectionException if a remote or network exception occurs.
      * @throws APIRequestException if a request exception occurs.

src/main/java/cn/jpush/api/admin/AdminClient.java

@@ -97,14 +97,13 @@ public AppResult deleteApp(String appKey) throws APIConnectionException, APIRequ
 
     /**
      * Upload certificate
-     * @param appKey
-     * @param devCertificatePassword
-     * @param proCertificatePassword
-     * @param devCertificateFile
-     * @param proCertificateFile
-     * @return
-     * @throws APIConnectionException
-     * @throws APIRequestException
+     * @param appKey app key
+     * @param devCertificatePassword dev certificate password
+     * @param proCertificatePassword pro certificate password
+     * @param devCertificateFile dev certificate file
+     * @param proCertificateFile pro certificate file
+     * @throws APIConnectionException connect exception
+     * @throws APIRequestException request exception
      */
     public void uploadCertificate(String appKey, String devCertificateFile, String devCertificatePassword,
                                   String proCertificateFile, String proCertificatePassword)

src/main/java/cn/jpush/api/image/ImageClient.java

@@ -49,8 +49,13 @@ public ImageClient(String masterSecret, String appKey, HttpProxy proxy, ClientCo
         this._httpClient = new NativeHttpClient(authCode, proxy, conf);
     }
 
+
     /**
      * Upload image by url. Require at least one non-null url.
+     * @param imageUrlPayload image url payload
+     * @return {@link ImageUploadResult}
+     * @throws APIConnectionException connect exception
+     * @throws APIRequestException request exception
      */
     public ImageUploadResult uploadImage(ImageUrlPayload imageUrlPayload)
             throws APIConnectionException, APIRequestException {
@@ -72,8 +77,13 @@ public ImageUploadResult uploadImage(ImageUrlPayload imageUrlPayload)
 
     /**
      * Upload image by file. Require at least 1 non-null fileName. Currently only support Xiaomi and OPPO
+     * @param imageFilePayload image file payload
+     * @return {@link ImageUploadResult}
+     * @throws APIConnectionException connect exception
+     * @throws APIRequestException request exception
      */
-    public ImageUploadResult uploadImage(ImageFilePayload imageFilePayload) {
+    public ImageUploadResult uploadImage(ImageFilePayload imageFilePayload)
+            throws APIConnectionException, APIRequestException{
         Preconditions.checkArgument(imageFilePayload.getImageType() != null, "Image type should not be null");
         checkImageFilePayload(imageFilePayload);
         NativeHttpClient client = (NativeHttpClient) _httpClient;
@@ -99,6 +109,11 @@ public ImageUploadResult uploadImage(ImageFilePayload imageFilePayload) {
 
     /**
      * Modify image by url. Require at least one non-null url.
+     * @param mediaId media id
+     * @param imageUrlPayload image url payload
+     * @return {@link ImageUploadResult}
+     * @throws APIConnectionException connection exception
+     * @throws APIRequestException request exception
      */
     public ImageUploadResult modifyImage(String mediaId, ImageUrlPayload imageUrlPayload)
             throws APIConnectionException, APIRequestException {
@@ -118,8 +133,14 @@ public ImageUploadResult modifyImage(String mediaId, ImageUrlPayload imageUrlPay
         return imageUploadResult;
     }
 
+
     /**
      * Modify image by file. Require at least 1 non-null fileName. Currently only support Xiaomi and OPPO
+     * @param mediaId media id
+     * @param imageFilePayload image file payload
+     * @return {@link ImageUploadResult}
+     * @throws APIConnectionException connection exception
+     * @throws APIRequestException request exception
      */
     public ImageUploadResult modifyImage(String mediaId, ImageFilePayload imageFilePayload) {
         Preconditions.checkArgument(StringUtils.isNotEmpty(mediaId), "mediaId should not be empty");