Skip to content

Commit 51d2ed7

Browse files
binarywangbinarywang
committed
🎨 批量修复部分javadoc里的错误标签或不规范代码
1 parent 37c2db9 commit 51d2ed7

File tree

112 files changed

+751
-419
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+751
-419
lines changed

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/api/WxConsts.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
/**
1313
* 微信开发所使用到的常量类.
1414
*
15-
* @author Daniel Qian & binarywang & Wang_Wong
15+
* @author Daniel Qian, binarywang, Wang_Wong
1616
*/
1717
@UtilityClass
1818
public class WxConsts {

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/bean/oauth2/WxOAuth2AccessToken.java‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
import java.io.Serializable;
88

99
/**
10-
* https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140842
10+
* OAuth2 AccessToken
11+
* <p>
12+
* 参考：{@code https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140842}
13+
* </p>
1114
*
1215
* @author Daniel Qian
1316
*/
@@ -36,8 +39,10 @@ public class WxOAuth2AccessToken implements Serializable {
3639
private Integer snapshotUser;
3740

3841
/**
39-
* https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&announce_id=11513156443eZYea&version=&lang=zh_CN.
4042
* 本接口在scope参数为snsapi_base时不再提供unionID字段。
43+
* <p>
44+
* 参考：{@code https://mp.weixin.qq.com/cgi-bin/announce?action=getannouncement&announce_id=11513156443eZYea&version=&lang=zh_CN}
45+
* </p>
4146
*/
4247
@SerializedName("unionid")
4348
private String unionId;

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxCpErrorMsgEnum.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ public enum WxCpErrorMsgEnum {
453453
*/
454454
CODE_60008(60008, "部门已存在；部门ID或者部门名称已存在"),
455455
/**
456-
* 部门名称含有非法字符；不能含有 \\:?*“< >| 等字符.
456+
* {@code 部门名称含有非法字符；不能含有 \\:?*"< >| 等字符.}
457457
*/
458458
CODE_60009(60009, "部门名称含有非法字符；不能含有 \\ :?*“< >| 等字符"),
459459
/**
@@ -521,7 +521,7 @@ public enum WxCpErrorMsgEnum {
521521
*/
522522
CODE_60124(60124, "无效的父部门id；父部门不存在通讯录中"),
523523
/**
524-
* 非法部门名字；不能为空，且不能超过64字节，且不能含有\\:*?”< >|等字符.
524+
* {@code 非法部门名字；不能为空，且不能超过64字节，且不能含有\\:*?"< >|等字符.}
525525
*/
526526
CODE_60125(60125, "非法部门名字；不能为空，且不能超过64字节，且不能含有\\:*?”< >|等字符"),
527527
/**

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxError.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,13 @@
1212

1313
/**
1414
* 微信错误码.
15+
* <p>
1516
* 请阅读：
1617
* 公众平台：<a href="https://developers.weixin.qq.com/doc/offiaccount/Getting_Started/Global_Return_Code.html">全局返回码说明</a>
1718
* 企业微信：<a href="https://work.weixin.qq.com/api/doc#10649">全局错误码</a>
19+
* </p>
1820
*
19-
* @author Daniel Qian & Binary Wang
21+
* @author Daniel Qian, Binary Wang
2022
*/
2123
@Data
2224
@NoArgsConstructor

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxMaErrorMsgEnum.java‎

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -46,23 +46,23 @@ public enum WxMaErrorMsgEnum {
4646
*/
4747
CODE_40003(40003, "openid 不正确"),
4848
/**
49-
* <pre>
5049
* 无效媒体文件类型
51-
* 对应操作：<code>uploadTempMedia</code>
50+
* <p>
51+
* 对应操作：{@code uploadTempMedia}
5252
* 对应地址：
53-
* POST https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE
53+
* {@code POST https://api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE}
5454
* 参考文档地址： https://developers.weixin.qq.com/miniprogram/dev/api/open-api/customer-message/uploadTempMedia.html
55-
* </pre>
55+
* </p>
5656
*/
5757
CODE_40004(40004, "无效媒体文件类型"),
5858
/**
59-
* <pre>
6059
* 无效媒体文件 ID.
61-
* 对应操作：<code>getTempMedia</code>
60+
* <p>
61+
* 对应操作：{@code getTempMedia}
6262
* 对应地址：
63-
* GET https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID
63+
* {@code GET https://api.weixin.qq.com/cgi-bin/media/get?access_token=ACCESS_TOKEN&media_id=MEDIA_ID}
6464
* 参考文档地址： https://developers.weixin.qq.com/miniprogram/dev/api/open-api/customer-message/getTempMedia.html
65-
* </pre>
65+
* </p>
6666
*/
6767
CODE_40007(40007, "无效媒体文件 ID"),
6868
/**
@@ -99,29 +99,29 @@ public enum WxMaErrorMsgEnum {
9999
*/
100100
CODE_41028(41028, "form_id 不正确，或者过期"),
101101
/**
102-
* <pre>
103102
* code 或 template_id 不正确.
104-
* 对应操作：<code>code2Session</code>, <code>sendUniformMessage</code>, <code>sendTemplateMessage</code>
103+
* <p>
104+
* 对应操作：{@code code2Session}, {@code sendUniformMessage}, {@code sendTemplateMessage}
105105
* 对应地址：
106-
* GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code
106+
* {@code GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code}
107107
* POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send?access_token=ACCESS_TOKEN
108108
* POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/send?access_token=ACCESS_TOKEN
109109
* 参考文档地址： https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/code2Session.html
110110
* https://developers.weixin.qq.com/miniprogram/dev/api/open-api/uniform-message/sendUniformMessage.html
111111
* https://developers.weixin.qq.com/miniprogram/dev/api/open-api/template-message/sendTemplateMessage.html
112-
* </pre>
112+
* </p>
113113
*/
114114
CODE_41029(41029, "请求的参数不正确"),
115115
/**
116-
* <pre>
117116
* form_id 已被使用，或者所传page页面不存在，或者小程序没有发布
118-
* 对应操作：<code>sendUniformMessage</coce>, <code>getWXACodeUnlimit</code>
117+
* <p>
118+
* 对应操作：{@code sendUniformMessage}, {@code getWXACodeUnlimit}
119119
* 对应地址：
120120
* POST https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send?access_token=ACCESS_TOKEN
121121
* POST https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=ACCESS_TOKEN
122122
* 参考文档地址： https://developers.weixin.qq.com/miniprogram/dev/api/open-api/uniform-message/sendUniformMessage.html
123-
* https://developers.weixin.qq.com/miniprogram/dev/api/open-api/qr-code/getWXACodeUnlimit.html
124-
* </pre>
123+
* https://developers.weixin.qq.com/miniprogram/dev/api/open-api/qr-code/getWXACodeUnlimit.html
124+
* </p>
125125
*/
126126
CODE_41030(41030, "请求的参数不正确"),
127127
/**
@@ -138,13 +138,13 @@ public enum WxMaErrorMsgEnum {
138138
*/
139139
CODE_45009(45009, "调用分钟频率受限"),
140140
/**
141-
* <pre>
142141
* 频率限制，每个用户每分钟100次.
143-
* 对应操作：<code>code2Session</code>
142+
* <p>
143+
* 对应操作：{@code code2Session}
144144
* 对应地址：
145-
* GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code
145+
* {@code GET https://api.weixin.qq.com/sns/jscode2session?appid=APPID&secret=SECRET&js_code=JSCODE&grant_type=authorization_code}
146146
* 参考文档地址： https://developers.weixin.qq.com/miniprogram/dev/api/open-api/login/code2Session.html
147-
* </pre>
147+
* </p>
148148
*/
149149
CODE_45011(45011, "频率限制，每个用户每分钟100次"),
150150
/**
@@ -190,12 +190,13 @@ public enum WxMaErrorMsgEnum {
190190
*/
191191
CODE_45072(45072, "command字段取值不对"),
192192
/**
193-
* <pre>
194193
* 下发输入状态，需要之前30秒内跟用户有过消息交互.
195-
* 对应操作：<code>customerTyping</code>
194+
* <p>
195+
* 对应操作：{@code customerTyping}
196196
* 对应地址：
197197
* POST https://api.weixin.qq.com/cgi-bin/message/custom/typing?access_token=ACCESS_TOKEN
198198
* 参考文档地址： https://developers.weixin.qq.com/miniprogram/dev/api/open-api/customer-message/customerTyping.html
199+
* </p>
199200
*/
200201
CODE_45080(45080, "下发输入状态，需要之前30秒内跟用户有过消息交互"),
201202
/**
@@ -686,7 +687,7 @@ public enum WxMaErrorMsgEnum {
686687

687688
/**
688689
* 89252
689-
* 法人&企业信息一致性校验中 front checking
690+
* {@code 法人&企业信息一致性校验中 front checking}
690691
*/
691692
CODE_89252(89252, "法人&企业信息一致性校验中"),
692693

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/error/WxOpenErrorMsgEnum.java‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ public enum WxOpenErrorMsgEnum {
527527
CODE_40099(40099, "invalid code, this code has consumed."),
528528

529529
/**
530-
* invalid DateInfo, Make Sure OldDateInfoType==NewDateInfoType && NewBeginTime<=OldBeginTime && OldEndTime<= NewEndTime
530+
* {@code invalid DateInfo, Make Sure OldDateInfoType==NewDateInfoType && NewBeginTime<=OldBeginTime && OldEndTime<= NewEndTime}
531531
*/
532532
CODE_40100(40100, "invalid DateInfo, Make Sure OldDateInfoType==NewDateInfoType && NewBeginTime<=OldBeginTime && OldEndTime<= NewEndTime"),
533533

@@ -572,7 +572,7 @@ public enum WxOpenErrorMsgEnum {
572572
CODE_40108(40108, "invalid client version"),
573573

574574
/**
575-
* too many code size, must <= 100
575+
* {@code too many code size, must <= 100}
576576
*/
577577
CODE_40109(40109, "too many code size, must <= 100"),
578578

@@ -702,7 +702,7 @@ public enum WxOpenErrorMsgEnum {
702702
CODE_40135(40135, "invalid not supply bonus, can not change card_id which supply bonus to be not supply"),
703703

704704
/**
705-
* invalid use DepositCodeMode, make sure sku.quantity>DepositCode.quantity
705+
* {@code invalid use DepositCodeMode, make sure sku.quantity>DepositCode.quantity}
706706
*/
707707
CODE_40136(40136, "invalid use DepositCodeMode, make sure sku.quantity>DepositCode.quantity"),
708708

@@ -1082,7 +1082,7 @@ public enum WxOpenErrorMsgEnum {
10821082
CODE_40211(40211, "invalid scope_data"),
10831083

10841084
/**
1085-
* paegs 当中存在不合法的query，query格式遵循URL标准，即k1=v1&k2=v2 invalid query
1085+
* {@code paegs 当中存在不合法的query，query格式遵循URL标准，即k1=v1&k2=v2 invalid query}
10861086
*/
10871087
CODE_40212(40212, "paegs 当中存在不合法的query，query格式遵循URL标准，即k1=v1&k2=v2"),
10881088

@@ -4242,7 +4242,7 @@ public enum WxOpenErrorMsgEnum {
42424242
CODE_71005(71005, "limit exe count"),
42434243

42444244
/**
4245-
* limit coin count, 1 <= coin_count <= 100000
4245+
* {@code limit coin count, 1 <= coin_count <= 100000}
42464246
*/
42474247
CODE_71006(71006, "limit coin count, 1 <= coin_count <= 100000"),
42484248

@@ -4347,7 +4347,7 @@ public enum WxOpenErrorMsgEnum {
43474347
CODE_72018(72018, "duplicate order id, invoice had inserted to user"),
43484348

43494349
/**
4350-
* limit msg operation card list size, must <= 5
4350+
* {@code limit msg operation card list size, must <= 5}
43514351
*/
43524352
CODE_72019(72019, "limit msg operation card list size, must <= 5"),
43534353

@@ -6432,7 +6432,7 @@ public enum WxOpenErrorMsgEnum {
64326432
CODE_88009(88009, "reply is not exists"),
64336433

64346434
/**
6435-
* count range error. cout <= 0 or count > 50
6435+
* {@code count range error. cout <= 0 or count > 50}
64366436
*/
64376437
CODE_88010(88010, "count range error. cout <= 0 or count > 50"),
64386438

@@ -6682,7 +6682,7 @@ public enum WxOpenErrorMsgEnum {
66826682
CODE_89251(89251, "模板消息已下发，待法人人脸核身校验"),
66836683

66846684
/**
6685-
* 法人&企业信息一致性校验中 front checking
6685+
* {@code 法人&企业信息一致性校验中 front checking}
66866686
*/
66876687
CODE_89253(89253, "法人&企业信息一致性校验中"),
66886688

@@ -7257,7 +7257,7 @@ public enum WxOpenErrorMsgEnum {
72577257
CODE_200021(200021, "场景描述 sceneDesc 参数错误"),
72587258

72597259
/**
7260-
* 禁止创建/更新商品（如商品创建功能被封禁） 或 禁止编辑&更新房间
7260+
* {@code 禁止创建/更新商品（如商品创建功能被封禁） 或 禁止编辑&更新房间}
72617261
*/
72627262
CODE_300001(300001, "禁止创建/更新商品（如商品创建功能被封禁） 或 禁止编辑&更新房间"),
72637263

@@ -8382,7 +8382,7 @@ public enum WxOpenErrorMsgEnum {
83828382
CODE_9300003(9300003, "begin_time must less than end_time"),
83838383

83848384
/**
8385-
* end_time - begin_time > 1year
8385+
* {@code end_time - begin_time > 1year}
83868386
*/
83878387
CODE_9300004(9300004, "end_time - begin_time > 1year"),
83888388

@@ -8397,7 +8397,7 @@ public enum WxOpenErrorMsgEnum {
83978397
CODE_9300006(9300006, "invalid activity status"),
83988398

83998399
/**
8400-
* gift_num must >0 and <=15
8400+
* {@code gift_num must >0 and <=15}
84018401
*/
84028402
CODE_9300007(9300007, "gift_num must >0 and <=15"),
84038403

@@ -8412,7 +8412,7 @@ public enum WxOpenErrorMsgEnum {
84128412
CODE_9300009(9300009, "activity can not finish"),
84138413

84148414
/**
8415-
* card_info_list must >= 2
8415+
* {@code card_info_list must >= 2}
84168416
*/
84178417
CODE_9300010(9300010, "card_info_list must >= 2"),
84188418

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/service/WxOcrService.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@
1212

1313
/**
1414
* 基于小程序或 H5 的身份证、银行卡、行驶证 OCR 识别.
15-
* https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21516712284rHWMX
15+
* <p>
16+
* 参考：{@code https://mp.weixin.qq.com/wiki?t=resource/res_main&id=21516712284rHWMX}
17+
* </p>
1618
*
1719
* @author <a href="https://github.com/binarywang">Binary Wang</a>
1820
* created on 2019-06-22

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/session/InternalSessionManager.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@ public interface InternalSessionManager {
77

88
/**
99
* Return the active Session, associated with this Manager, with the
10-
* specified session id (if any); otherwise return <code>null</code>.
10+
* specified session id (if any); otherwise return {@code null}.
1111
*
1212
* @param id The session id for the session to be returned
13+
* @return the session or null
1314
* @throws IllegalStateException if a new session cannot be
1415
* instantiated for any reason
15-
* @throws java.io.IOException if an input/output error occurs while
16-
* processing this request
1716
*/
1817
InternalSession findSession(String id);
1918

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/util/SignUtils.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ public class SignUtils {
2525
*
2626
* @param message 签名数据
2727
* @param key 签名密钥
28+
* @return 签名结果
2829
*/
2930
public static String createHmacSha256Sign(String message, String key) {
3031
try {

‎weixin-java-common/src/main/java/me/chanjar/weixin/common/util/crypto/SHA1.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,10 @@ public static String gen(String... arr) {
2929
}
3030

3131
/**
32-
* 用&串接arr参数，生成sha1 digest.
32+
* {@code 用&串接arr参数，生成sha1 digest.}
33+
*
34+
* @param arr 参数数组
35+
* @return sha1摘要
3336
*/
3437
public static String genWithAmple(String... arr) {
3538
if (StringUtils.isAnyEmpty(arr)) {

0 commit comments

Comments
 (0)