From b466dd8de3b3dadb5418b0b27c07ce0bfbc5de72 Mon Sep 17 00:00:00 2001
From: "yadong.zhang" <yadong.zhang0415@gmail.com>
Date: Wed, 7 Aug 2019 10:54:36 +0800
Subject: [PATCH] :beers: add package-info

---
 src/main/java/me/zhyd/oauth/cache/package-info.java    |  5 +++++
 src/main/java/me/zhyd/oauth/config/package-info.java   |  4 ++++
 src/main/java/me/zhyd/oauth/enums/package-info.java    |  4 ++++
 .../java/me/zhyd/oauth/exception/package-info.java     |  4 ++++
 src/main/java/me/zhyd/oauth/log/package-info.java      |  4 ++++
 src/main/java/me/zhyd/oauth/model/package-info.java    |  4 ++++
 src/main/java/me/zhyd/oauth/package-info.java          |  8 ++++++++
 src/main/java/me/zhyd/oauth/request/AuthRequest.java   | 10 +++++++++-
 src/main/java/me/zhyd/oauth/request/package-info.java  |  4 ++++
 src/main/java/me/zhyd/oauth/utils/package-info.java    |  4 ++++
 10 files changed, 50 insertions(+), 1 deletion(-)
 create mode 100644 src/main/java/me/zhyd/oauth/cache/package-info.java
 create mode 100644 src/main/java/me/zhyd/oauth/config/package-info.java
 create mode 100644 src/main/java/me/zhyd/oauth/enums/package-info.java
 create mode 100644 src/main/java/me/zhyd/oauth/exception/package-info.java
 create mode 100644 src/main/java/me/zhyd/oauth/log/package-info.java
 create mode 100644 src/main/java/me/zhyd/oauth/model/package-info.java
 create mode 100644 src/main/java/me/zhyd/oauth/package-info.java
 create mode 100644 src/main/java/me/zhyd/oauth/request/package-info.java
 create mode 100644 src/main/java/me/zhyd/oauth/utils/package-info.java

diff --git a/src/main/java/me/zhyd/oauth/cache/package-info.java b/src/main/java/me/zhyd/oauth/cache/package-info.java
new file mode 100644
index 0000000..76a1816
--- /dev/null
+++ b/src/main/java/me/zhyd/oauth/cache/package-info.java
@@ -0,0 +1,5 @@
+/**
+ * JustAuth 缓存实现， 提供基础的基于ConcurrentHashMap + ScheduledExecutorService 实现的定时缓存。
+ * 同时对外暴露{@code AuthStateCache}接口，可进行对缓存实现的自定义。
+ */
+package me.zhyd.oauth.cache;
diff --git a/src/main/java/me/zhyd/oauth/config/package-info.java b/src/main/java/me/zhyd/oauth/config/package-info.java
new file mode 100644
index 0000000..6d2f3df
--- /dev/null
+++ b/src/main/java/me/zhyd/oauth/config/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * JustAuth 核心配置相关，包括{@code AuthConfig}和{@code AuthSource}
+ */
+package me.zhyd.oauth.config;
diff --git a/src/main/java/me/zhyd/oauth/enums/package-info.java b/src/main/java/me/zhyd/oauth/enums/package-info.java
new file mode 100644
index 0000000..e4dc075
--- /dev/null
+++ b/src/main/java/me/zhyd/oauth/enums/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * 提供一些必要的枚举类
+ */
+package me.zhyd.oauth.enums;
diff --git a/src/main/java/me/zhyd/oauth/exception/package-info.java b/src/main/java/me/zhyd/oauth/exception/package-info.java
new file mode 100644
index 0000000..3988323
--- /dev/null
+++ b/src/main/java/me/zhyd/oauth/exception/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * JustAuth专用异常封装
+ */
+package me.zhyd.oauth.exception;
diff --git a/src/main/java/me/zhyd/oauth/log/package-info.java b/src/main/java/me/zhyd/oauth/log/package-info.java
new file mode 100644
index 0000000..8152169
--- /dev/null
+++ b/src/main/java/me/zhyd/oauth/log/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * 针对JustAuth简单封装的日志打印工具，可用过{@link me.zhyd.oauth.log.Log.Config}开关日志和指定日志级别
+ */
+package me.zhyd.oauth.log;
diff --git a/src/main/java/me/zhyd/oauth/model/package-info.java b/src/main/java/me/zhyd/oauth/model/package-info.java
new file mode 100644
index 0000000..006b916
--- /dev/null
+++ b/src/main/java/me/zhyd/oauth/model/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * JustAuth核心模型类，封装了用户、token、响应和callback等实体类
+ */
+package me.zhyd.oauth.model;
diff --git a/src/main/java/me/zhyd/oauth/package-info.java b/src/main/java/me/zhyd/oauth/package-info.java
new file mode 100644
index 0000000..c946a0e
--- /dev/null
+++ b/src/main/java/me/zhyd/oauth/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * JustAuth，如你所见，它仅仅是一个第三方授权登录的工具类库，它可以让我们脱离繁琐的第三方登录SDK，让登录变得So easy!
+ * <p>
+ * 史上最全的整合第三方登录的开源库。目前已支持Github、Gitee、微博、钉钉、百度、Coding、腾讯云开发者平台、OSChina、
+ * 支付宝、QQ、微信、淘宝、Google、Facebook、抖音、领英、小米、微软、今日头条、Teambition、StackOverflow、Pinterest、
+ * 人人、华为和企业微信等第三方平台的授权登录。 Login, so easy!
+ */
+package me.zhyd.oauth;
diff --git a/src/main/java/me/zhyd/oauth/request/AuthRequest.java b/src/main/java/me/zhyd/oauth/request/AuthRequest.java
index 53e6b38..e4bd718 100644
--- a/src/main/java/me/zhyd/oauth/request/AuthRequest.java
+++ b/src/main/java/me/zhyd/oauth/request/AuthRequest.java
@@ -1,12 +1,20 @@
 package me.zhyd.oauth.request;
 
+import me.zhyd.oauth.enums.AuthResponseStatus;
 import me.zhyd.oauth.exception.AuthException;
 import me.zhyd.oauth.model.AuthCallback;
 import me.zhyd.oauth.model.AuthResponse;
-import me.zhyd.oauth.enums.AuthResponseStatus;
 import me.zhyd.oauth.model.AuthToken;
 
 /**
+ * JustAuth {@code Request}公共接口，所有平台的{@code Request}都需要实现该接口
+ * <p>
+ * {@link AuthRequest#authorize()}
+ * {@link AuthRequest#authorize(String)}
+ * {@link AuthRequest#login(AuthCallback)}
+ * {@link AuthRequest#revoke(AuthToken)}
+ * {@link AuthRequest#refresh(AuthToken)}
+ *
  * @author yadong.zhang (yadong.zhang0415(a)gmail.com)
  * @since 1.8
  */
diff --git a/src/main/java/me/zhyd/oauth/request/package-info.java b/src/main/java/me/zhyd/oauth/request/package-info.java
new file mode 100644
index 0000000..2a8a751
--- /dev/null
+++ b/src/main/java/me/zhyd/oauth/request/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * JustAuth核心组件，所有授权登录都是基于{@code request}实现
+ */
+package me.zhyd.oauth.request;
diff --git a/src/main/java/me/zhyd/oauth/utils/package-info.java b/src/main/java/me/zhyd/oauth/utils/package-info.java
new file mode 100644
index 0000000..f6731cc
--- /dev/null
+++ b/src/main/java/me/zhyd/oauth/utils/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * 提供一些简单的工具和校验等
+ */
+package me.zhyd.oauth.utils;
-- 
GitLab