🎨 规范部分javadoc文档

Author: binarywang

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpApprovalDataResult.java

@@ -7,10 +7,10 @@
 import java.util.Map;
 
 /**
+ * 企业微信 OA 审批数据.
+ *
  * @author Element
- * @Package me.chanjar.weixin.cp.bean
  * @date 2019-04-06 14:36
- * @Description: 企业微信 OA 审批数据
  */
 @Data
 public class WxCpApprovalDataResult implements Serializable {
@@ -27,17 +27,16 @@ public class WxCpApprovalDataResult implements Serializable {
   private Integer total;
 
   @SerializedName("next_spnum")
-  private Long nextSpnum;
+  private Long nextSpNum;
 
   private WxCpApprovalData[] data;
 
 
   @Data
-  public static class WxCpApprovalData implements Serializable{
-
+  public static class WxCpApprovalData implements Serializable {
     private static final long serialVersionUID = -3051785319608491640L;
-
-    private String spname;
+    @SerializedName("spname")
+    private String spName;
 
     @SerializedName("apply_name")
     private String applyName;
@@ -64,6 +63,6 @@ public static class WxCpApprovalData implements Serializable{
     private String applyUserId;
 
     @SerializedName("comm")
-    private Map<String,String> comm;
+    private Map<String, String> comm;
   }
 }

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpCheckinData.java

@@ -7,14 +7,13 @@
 import java.util.List;
 
 /**
+ * 企业微信打卡数据.
+ *
  * @author Element
- * @Package me.chanjar.weixin.cp.bean
  * @date 2019-04-06 11:01
- * @Description: 企业微信打卡数据
  */
 @Data
 public class WxCpCheckinData implements Serializable {
-
   private static final long serialVersionUID = 1915820330847799605L;
 
   @SerializedName("userid")
@@ -42,7 +41,7 @@ public class WxCpCheckinData implements Serializable {
   private String wifiName;
 
   @SerializedName("wifimac")
-  private String wifiMAC;
+  private String wifiMac;
 
   private String notes;
 

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpCheckinOption.java

@@ -7,10 +7,10 @@
 import java.util.List;
 
 /**
+ * 企业微信打卡规则.
+ *
  * @author Element
- * @Package me.chanjar.weixin.cp.bean
  * @date 2019-04-06 13:22
- * @Description: 企业微信打卡规则
  */
 @Data
 public class WxCpCheckinOption implements Serializable {
@@ -21,10 +21,8 @@ public class WxCpCheckinOption implements Serializable {
 
   private Group group;
 
-
   @Data
   public static class CheckinDate implements Serializable {
-
     private static final long serialVersionUID = -5601722383347110974L;
 
     private List<Integer> workdays;
@@ -36,15 +34,14 @@ public static class CheckinDate implements Serializable {
     private Long flexTime;
 
     @SerializedName("noneed_offwork")
-    private Boolean noneedOffwork;
+    private Boolean noNeedOffwork;
 
     @SerializedName("limit_aheadtime")
-    private Long limitAheadtime;
+    private Long limitAheadTime;
   }
 
   @Data
   public static class CheckinTime implements Serializable {
-
     private static final long serialVersionUID = -8579954143265336276L;
 
     @SerializedName("work_sec")
@@ -90,25 +87,24 @@ public static class Group implements Serializable {
     private Boolean needPhoto;
 
     @SerializedName("note_can_use_local_pic")
-    private Boolean note_can_use_local_pic;
+    private Boolean noteCanUseLocalPic;
 
     @SerializedName("allow_checkin_offworkday")
-    private Boolean allow_checkin_offworkday;
+    private Boolean allowCheckinOffWorkday;
 
     @SerializedName("allow_apply_offworkday")
-    private Boolean allow_apply_offworkday;
+    private Boolean allowApplyOffWorkday;
 
     @SerializedName("wifimac_infos")
-    private List<WifiMACInfo> wifiMACInfos;
+    private List<WifiMacInfo> wifiMacInfos;
 
     @SerializedName("loc_infos")
     private List<LocInfo> locInfos;
 
   }
 
   @Data
-  public static class WifiMACInfo implements Serializable{
-
+  public static class WifiMacInfo implements Serializable {
     private static final long serialVersionUID = -4657809185716627368L;
 
     @SerializedName("wifiname")
@@ -119,8 +115,7 @@ public static class WifiMACInfo implements Serializable{
   }
 
   @Data
-  public static class LocInfo implements Serializable{
-
+  public static class LocInfo implements Serializable {
     private static final long serialVersionUID = -618965280668099608L;
 
     private Long lat;
@@ -136,8 +131,7 @@ public static class LocInfo implements Serializable{
   }
 
   @Data
-  public static class SpeDay implements Serializable{
-
+  public static class SpeDay implements Serializable {
     private static final long serialVersionUID = -3538818921359212748L;
 
     private Long timestamp;

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/bean/WxCpDialRecord.java

@@ -7,10 +7,10 @@
 import java.util.List;
 
 /**
+ * 公费电话拨打记录.
+ *
  * @author Element
- * @Package me.chanjar.weixin.cp.bean
  * @date 2019-04-06 15:38
- * @Description: 公费电话拨打记录
  */
 @Data
 public class WxCpDialRecord implements Serializable {
@@ -39,7 +39,7 @@ public class WxCpDialRecord implements Serializable {
    * 主叫信息
    */
   @Data
-  public static class Caller implements Serializable{
+  public static class Caller implements Serializable {
 
     private static final long serialVersionUID = 4792200404338145607L;
 
@@ -53,7 +53,7 @@ public static class Caller implements Serializable{
    * 被叫信息
    */
   @Data
-  public static class Callee implements Serializable{
+  public static class Callee implements Serializable {
 
     private static final long serialVersionUID = 2390963671336179550L;
 

weixin-java-cp/src/main/java/me/chanjar/weixin/cp/util/crypto/WxCpTpCryptUtil.java

@@ -1,52 +1,30 @@
-/**
- * 对公众平台发送给公众账号的消息加解密示例代码.
- *
- * @copyright Copyright (c) 1998-2014 Tencent Inc.
- * <p>
- * 针对org.apache.commons.codec.binary.Base64，
- * 需要导入架包commons-codec-1.9（或commons-codec-1.8等其他版本）
- * 官方下载地址：http://commons.apache.org/proper/commons-codec/download_codec.cgi
- * <p>
- * 针对org.apache.commons.codec.binary.Base64，
- * 需要导入架包commons-codec-1.9（或commons-codec-1.8等其他版本）
- * 官方下载地址：http://commons.apache.org/proper/commons-codec/download_codec.cgi
- */
-
-// ------------------------------------------------------------------------
-
-/**
- * 针对org.apache.commons.codec.binary.Base64，
- * 需要导入架包commons-codec-1.9（或commons-codec-1.8等其他版本）
- * 官方下载地址：http://commons.apache.org/proper/commons-codec/download_codec.cgi
- */
-package me.chanjar.weixin.cp.util.crypto;
-
-import org.apache.commons.codec.binary.Base64;
-
-import me.chanjar.weixin.common.util.crypto.WxCryptUtil;
-import me.chanjar.weixin.cp.config.WxCpTpConfigStorage;
-
-public class WxCpTpCryptUtil extends WxCryptUtil {
-
-  /**
-   * 构造函数
-   *
-   * @param wxCpConfigStorage
-   */
-  public WxCpTpCryptUtil(WxCpTpConfigStorage wxCpTpConfigStorage) {
-    /*
-     * @param token          公众平台上，开发者设置的token
-     * @param encodingAesKey 公众平台上，开发者设置的EncodingAESKey
-     * @param appidOrCorpid          公众平台corpId
-     */
-    String encodingAesKey = wxCpTpConfigStorage.getAesKey();
-    String token = wxCpTpConfigStorage.getToken();
-    String corpId = wxCpTpConfigStorage.getCorpId();
-
-    this.token = token;
-    this.appidOrCorpid = corpId;
-    this.aesKey = Base64.decodeBase64(encodingAesKey + "=");
-  }
-
-
-}
+package me.chanjar.weixin.cp.util.crypto;
+
+import me.chanjar.weixin.common.util.crypto.WxCryptUtil;
+import me.chanjar.weixin.cp.config.WxCpTpConfigStorage;
+import org.apache.commons.codec.binary.Base64;
+
+/**
+ * @author someone
+ */
+public class WxCpTpCryptUtil extends WxCryptUtil {
+  /**
+   * 构造函数.
+   */
+  public WxCpTpCryptUtil(WxCpTpConfigStorage wxCpTpConfigStorage) {
+    /*
+     * @param token          公众平台上，开发者设置的token
+     * @param encodingAesKey 公众平台上，开发者设置的EncodingAESKey
+     * @param appidOrCorpid          公众平台corpId
+     */
+    String encodingAesKey = wxCpTpConfigStorage.getAesKey();
+    String token = wxCpTpConfigStorage.getToken();
+    String corpId = wxCpTpConfigStorage.getCorpId();
+
+    this.token = token;
+    this.appidOrCorpid = corpId;
+    this.aesKey = Base64.decodeBase64(encodingAesKey + "=");
+  }
+
+
+}

weixin-java-miniapp/src/main/java/cn/binarywang/wx/miniapp/api/WxMaTemplateService.java

@@ -10,27 +10,27 @@
 
 public interface WxMaTemplateService {
   /**
-   * 获取小程序模板库标题列表
+   * 获取小程序模板库标题列表.
    */
   String TEMPLATE_LIBRARY_LIST_URL = "https://api.weixin.qq.com/cgi-bin/wxopen/template/library/list";
 
   /**
-   * 获取模板库某个模板标题下关键词库
+   * 获取模板库某个模板标题下关键词库.
    */
   String TEMPLATE_LIBRARY_KEYWORD_URL = "https://api.weixin.qq.com/cgi-bin/wxopen/template/library/get";
 
   /**
-   * 组合模板并添加至帐号下的个人模板库
+   * 组合模板并添加至帐号下的个人模板库.
    */
   String TEMPLATE_ADD_URL = "https://api.weixin.qq.com/cgi-bin/wxopen/template/add";
 
   /**
-   * 获取帐号下已存在的模板列表
+   * 获取帐号下已存在的模板列表.
    */
   String TEMPLATE_LIST_URL = "https://api.weixin.qq.com/cgi-bin/wxopen/template/list";
 
   /**
-   * 删除帐号下的某个模板
+   * 删除帐号下的某个模板.
    */
   String TEMPLATE_DEL_URL = "https://api.weixin.qq.com/cgi-bin/wxopen/template/del";
 
@@ -41,10 +41,6 @@ public interface WxMaTemplateService {
    * 详情请见: <a href="https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1500465446_j4CgR&token=&lang=zh_CN">获取小程序模板库标题列表</a>
    * 接口url格式: https://api.weixin.qq.com/cgi-bin/wxopen/template/library/list?access_token=ACCESS_TOKEN
    * </pre>
-   *
-   * @param offset
-   * @param count
-   * @return
    */
   WxMaTemplateLibraryListResult findTemplateLibraryList(int offset, int count) throws WxErrorException;
 
@@ -55,9 +51,6 @@ public interface WxMaTemplateService {
    * 详情请见: <a href="https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1500465446_j4CgR&token=&lang=zh_CN">获取小程序模板库标题列表</a>
    * 接口url格式: https://api.weixin.qq.com/cgi-bin/wxopen/template/library/get?access_token=ACCESS_TOKEN
    * </pre>
-   *
-   * @param id
-   * @return
    */
   WxMaTemplateLibraryGetResult findTemplateLibraryKeywordList(String id) throws WxErrorException;
 
@@ -68,10 +61,6 @@ public interface WxMaTemplateService {
    * 详情请见: <a href="https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1500465446_j4CgR&token=&lang=zh_CN">获取小程序模板库标题列表</a>
    * 接口url格式: https://api.weixin.qq.com/cgi-bin/wxopen/template/add?access_token=ACCESS_TOKEN
    * </pre>
-   *
-   * @param id
-   * @param keywordIdList
-   * @return
    */
   WxMaTemplateAddResult addTemplate(String id, List<Integer> keywordIdList) throws WxErrorException;
 
@@ -82,10 +71,6 @@ public interface WxMaTemplateService {
    * 详情请见: <a href="https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1500465446_j4CgR&token=&lang=zh_CN">获取小程序模板库标题列表</a>
    * 接口url格式: https://api.weixin.qq.com/cgi-bin/wxopen/template/list?access_token=ACCESS_TOKEN
    * </pre>
-   *
-   * @param offset
-   * @param count
-   * @return
    */
   WxMaTemplateListResult findTemplateList(int offset, int count) throws WxErrorException;
 
@@ -96,8 +81,6 @@ public interface WxMaTemplateService {
    * 详情请见: <a href="https://open.weixin.qq.com/cgi-bin/showdocument?action=dir_list&t=resource/res_list&verify=1&id=open1500465446_j4CgR&token=&lang=zh_CN">获取小程序模板库标题列表</a>
    * 接口url格式: https://api.weixin.qq.com/cgi-bin/wxopen/template/list?access_token=ACCESS_TOKEN
    * </pre>
-   *
-   * @param templateId
    */
   boolean delTemplate(String templateId) throws WxErrorException;
 }