💡 规范注释

2026-04-25 19:18:50 +08:00 · 2019-07-27 07:55:52 +08:00
parent 64aa1940e4
commit a2d6dfe707
34 changed files with 47 additions and 36 deletions
--- a/src/main/java/me/zhyd/oauth/request/AuthAlipayRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthAlipayRequest.java
@@ -21,7 +21,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * 支付宝登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.0.1
 */
 public class AuthAlipayRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthBaiduRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthBaiduRequest.java
@@ -15,7 +15,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * 百度账号登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.0.0
 */
 public class AuthBaiduRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthCodingRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthCodingRequest.java
@@ -15,7 +15,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * Cooding登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.0.0
 */
 public class AuthCodingRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthCsdnRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthCsdnRequest.java
@@ -14,7 +14,7 @@ import me.zhyd.oauth.model.AuthUser;
 * CSDN登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.0.0
 */
@Deprecated
 public class AuthCsdnRequest extends AuthDefaultRequest {
--- a/src/main/java/me/zhyd/oauth/request/AuthDefaultRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthDefaultRequest.java
@@ -16,7 +16,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
 * @author yangkai.shen (https://xkcoding.com)
- * @since 1.8
+ * @since 1.0.0
 */
@Slf4j
 public abstract class AuthDefaultRequest implements AuthRequest {
--- a/src/main/java/me/zhyd/oauth/request/AuthDingTalkRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthDingTalkRequest.java
@@ -18,7 +18,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * 钉钉登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.0.0
 */
 public class AuthDingTalkRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthDouyinRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthDouyinRequest.java
@@ -15,7 +15,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * 抖音登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.4.0
 */
 public class AuthDouyinRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthFacebookRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthFacebookRequest.java
@@ -15,7 +15,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * Facebook登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.3.0
 */
 public class AuthFacebookRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthGiteeRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthGiteeRequest.java
@@ -14,7 +14,7 @@ import me.zhyd.oauth.model.AuthUser;
 * Gitee登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.0.0
 */
 public class AuthGiteeRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthGithubRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthGithubRequest.java
@@ -17,7 +17,7 @@ import java.util.Map;
 * Github登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.0.0
 */
 public class AuthGithubRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthGoogleRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthGoogleRequest.java
@@ -16,7 +16,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * Google登录
 *
 * @author yangkai.shen (https://xkcoding.com)
- * @since 1.3
+ * @since 1.3.0
 */
 public class AuthGoogleRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthLinkedinRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthLinkedinRequest.java
@@ -18,7 +18,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * 领英登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.4.0
 */
 public class AuthLinkedinRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthMiRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthMiRequest.java
@@ -18,7 +18,7 @@ import java.text.MessageFormat;
 * 小米登录
 *
 * @author yangkai.shen (https://xkcoding.com)
- * @since 1.5
+ * @since 1.5.0
 */
@Slf4j
 public class AuthMiRequest extends AuthDefaultRequest {
--- a/src/main/java/me/zhyd/oauth/request/AuthMicrosoftRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthMicrosoftRequest.java
@@ -16,7 +16,7 @@ import static me.zhyd.oauth.utils.GlobalAuthUtil.parseQueryToMap;
 * 微软登录
 *
 * @author yangkai.shen (https://xkcoding.com)
- * @since 1.5
+ * @since 1.5.0
 */
 public class AuthMicrosoftRequest extends AuthDefaultRequest {
    public AuthMicrosoftRequest(AuthConfig config) {
--- a/src/main/java/me/zhyd/oauth/request/AuthOschinaRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthOschinaRequest.java
@@ -15,7 +15,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * oschina登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.0.0
 */
 public class AuthOschinaRequest extends AuthDefaultRequest {

@@ -58,7 +58,7 @@ public class AuthOschinaRequest extends AuthDefaultRequest {
    /**
     * 返回获取accessToken的url
     *
-     * @param code
+     * @param code 授权回调时带回的授权码
     * @return 返回获取accessToken的url
     */
    @Override
--- a/src/main/java/me/zhyd/oauth/request/AuthPinterestRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthPinterestRequest.java
@@ -19,7 +19,7 @@ import static me.zhyd.oauth.config.AuthSource.PINTEREST;
 * Pinterest登录
 *
 * @author hongwei.peng (pengisgood(at)gmail(dot)com)
- * @since 1.8
+ * @since 1.9.0
 */
 public class AuthPinterestRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthQqRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthQqRequest.java
@@ -20,7 +20,7 @@ import java.util.Map;
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
 * @author yangkai.shen (https://xkcoding.com)
- * @since 1.8
+ * @since 1.1.0
 */
 public class AuthQqRequest extends AuthDefaultRequest {
    public AuthQqRequest(AuthConfig config) {
@@ -68,6 +68,13 @@ public class AuthQqRequest extends AuthDefaultRequest {
            .build();
    }

+    /**
+     * 获取QQ用户的OpenId，支持自定义是否启用查询unionid的功能，如果启用查询unionid的功能，
+     * 那就需要调用者先通过邮件申请unionid功能，参考链接 {@see http://wiki.connect.qq.com/unionid%E4%BB%8B%E7%BB%8D}
+     *
+     * @param authToken 通过{@link AuthQqRequest#getAccessToken(AuthCallback)}获取到的{@code authToken}
+     * @return openId
+     */
    private String getOpenId(AuthToken authToken) {
        HttpResponse response = HttpRequest.get(UrlBuilder.fromBaseUrl("https://graph.qq.com/oauth2.0/me")
            .queryParam("access_token", authToken.getAccessToken())
--- a/src/main/java/me/zhyd/oauth/request/AuthRenrenRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthRenrenRequest.java
@@ -19,7 +19,7 @@ import static me.zhyd.oauth.model.AuthResponseStatus.SUCCESS;
 * 人人登录
 *
 * @author hongwei.peng (pengisgood(at)gmail(dot)com)
- * @since 1.8
+ * @since 1.9.0
 */
 public class AuthRenrenRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthStackOverflowRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthStackOverflowRequest.java
@@ -18,7 +18,7 @@ import static me.zhyd.oauth.utils.GlobalAuthUtil.parseQueryToMap;
 * Stack Overflow登录
 *
 * @author hongwei.peng (pengisgood(at)gmail(dot)com)
- * @since 1.8
+ * @since 1.9.0
 */
 public class AuthStackOverflowRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthTaobaoRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthTaobaoRequest.java
@@ -16,7 +16,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * 淘宝登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.1.0
 */
 public class AuthTaobaoRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthTeambitionRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthTeambitionRequest.java
@@ -13,7 +13,7 @@ import me.zhyd.oauth.model.*;
 * Teambition授权登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.9.0
 */
 public class AuthTeambitionRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthTencentCloudRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthTencentCloudRequest.java
@@ -15,7 +15,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * 腾讯云登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.0.0
 */
 public class AuthTencentCloudRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthToutiaoRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthToutiaoRequest.java
@@ -16,7 +16,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * 今日头条登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.5
+ * @since 1.6.0-beta
 */
 public class AuthToutiaoRequest extends AuthDefaultRequest {

--- a/src/main/java/me/zhyd/oauth/request/AuthWeChatRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthWeChatRequest.java
@@ -14,7 +14,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * 微信登录
 *
 * @author yangkai.shen (https://xkcoding.com)
- * @since 1.8
+ * @since 1.1.0
 */
 public class AuthWeChatRequest extends AuthDefaultRequest {
    public AuthWeChatRequest(AuthConfig config) {
--- a/src/main/java/me/zhyd/oauth/request/AuthWeiboRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthWeiboRequest.java
@@ -19,7 +19,7 @@ import me.zhyd.oauth.utils.UrlBuilder;
 * 微博登录
 *
 * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
- * @since 1.8
+ * @since 1.0.0
 */
 public class AuthWeiboRequest extends AuthDefaultRequest {