From c8518ba3d840e6052abc03de01d904b40b2f9d6e Mon Sep 17 00:00:00 2001
From: springboot-plus <springbootplus@aliyun.com>
Date: Sun, 8 Sep 2019 01:33:00 +0800
Subject: [PATCH] :computer: 1.2.3.RELEASE Java Api Docs

---
 CHANGELOG.md                                  |  1 +
 README-zh.md                                  |  3 +++
 README.md                                     |  3 +++
 pom.xml                                       | 26 +++++++++++++++++--
 .../common/constant/CommonRedisKey.java       |  2 +-
 .../security/config/JwtProperties.java        |  2 +-
 .../security/controller/LoginController.java  |  2 +-
 .../security/interceptor/JwtInterceptor.java  |  2 +-
 .../security/param/LoginParam.java            |  2 +-
 .../security/service/LoginService.java        |  2 +-
 .../service/impl/LoginServiceImpl.java        |  2 +-
 .../springbootplus/security/util/JwtUtil.java |  2 +-
 .../security/vo/ClientInfo.java               |  2 +-
 .../security/vo/DeviceInfo.java               |  2 +-
 .../security/vo/JwtTokenRedisVo.java          |  2 +-
 .../security/vo/LoginSysUserRedisVo.java      |  2 +-
 .../security/vo/LoginSysUserVo.java           |  2 +-
 .../springbootplus/util/ClientInfoUtil.java   |  2 +-
 .../geekidea/springbootplus/util/MapUtil.java |  2 +-
 .../util/PrintApplicationInfo.java            |  2 +-
 20 files changed, 47 insertions(+), 18 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 41a22db0..7096eb06 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -22,6 +22,7 @@
 
 ### 📔  Documentation
 [CentOS Quick Installation Environment / Build / Deploy / Launch Spring-boot-plus Project](https://github.com/geekidea/spring-boot-plus#centos-quick-installation-environment--build--deploy--launch-spring-boot-plus-project)
+[spring-boot-plus java docs](http://geekidea.io/spring-boot-plus-apidocs/)
 
 ### 🔨 Dependency Upgrades
 - Upgrade to `springboot` 2.1.8.RELEASE
diff --git a/README-zh.md b/README-zh.md
index 70d2db03..c6bef701 100644
--- a/README-zh.md
+++ b/README-zh.md
@@ -36,6 +36,9 @@
 ## CHANGELOG
 #### [CHANGELOG.md](https://github.com/geekidea/spring-boot-plus/blob/master/CHANGELOG.md)
 
+## Java Docs
+#### [Java Api Docs](http://geekidea.io/spring-boot-plus-apidocs/)
+
 ## 项目架构
 ![spring-boot-plus-architecture.jpg](https://raw.githubusercontent.com/geekidea/spring-boot-plus/master/docs/img/spring-boot-plus-architecture.jpg)
 
diff --git a/README.md b/README.md
index 573cd94b..0f8477cc 100644
--- a/README.md
+++ b/README.md
@@ -38,6 +38,9 @@
 ## CHANGELOG
 #### [CHANGELOG.md](https://github.com/geekidea/spring-boot-plus/blob/master/CHANGELOG.md)
 
+## Java Docs
+#### [Java Api Docs](http://geekidea.io/spring-boot-plus-apidocs/)
+
 ## Architecture
 ![spring-boot-plus-architecture.jpg](https://raw.githubusercontent.com/geekidea/spring-boot-plus/master/docs/img/spring-boot-plus-architecture.jpg)
 
diff --git a/pom.xml b/pom.xml
index 687756a0..4bf7774c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -42,8 +42,9 @@
     </developers>
 
     <properties>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+        <utf8>UTF-8</utf8>
+        <project.build.sourceEncoding>${utf8}</project.build.sourceEncoding>
+        <project.reporting.outputEncoding>${utf8}</project.reporting.outputEncoding>
         <project-parent.version>${parent.version}</project-parent.version>
         <java.version>1.8</java.version>
         <spring-boot.version>2.1.8.RELEASE</spring-boot.version>
@@ -69,6 +70,7 @@
         <maven-compiler-plugin.version>3.8.1</maven-compiler-plugin.version>
         <maven-resources-plugin.version>3.1.0</maven-resources-plugin.version>
         <maven-surefire-plugin.version>2.22.2</maven-surefire-plugin.version>
+        <maven-javadoc-plugin.version>3.1.1</maven-javadoc-plugin.version>
     </properties>
 
     <dependencyManagement>
@@ -357,6 +359,26 @@
                 </executions>
             </plugin>
 
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>${maven-javadoc-plugin.version}</version>
+                <configuration>
+                    <additionalOptions>
+                        <additionalOption>-Xdoclint:none</additionalOption>
+                    </additionalOptions>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+
         </plugins>
 
     </build>
diff --git a/src/main/java/io/geekidea/springbootplus/common/constant/CommonRedisKey.java b/src/main/java/io/geekidea/springbootplus/common/constant/CommonRedisKey.java
index ba1c4416..05910703 100644
--- a/src/main/java/io/geekidea/springbootplus/common/constant/CommonRedisKey.java
+++ b/src/main/java/io/geekidea/springbootplus/common/constant/CommonRedisKey.java
@@ -20,7 +20,7 @@
  * <p>
  *  redis key 常量
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 public interface CommonRedisKey {
diff --git a/src/main/java/io/geekidea/springbootplus/security/config/JwtProperties.java b/src/main/java/io/geekidea/springbootplus/security/config/JwtProperties.java
index c7ab3569..9a30dd81 100644
--- a/src/main/java/io/geekidea/springbootplus/security/config/JwtProperties.java
+++ b/src/main/java/io/geekidea/springbootplus/security/config/JwtProperties.java
@@ -24,7 +24,7 @@
  * <p>
  *  Jwt配置属性
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-22
  **/
 @Data
diff --git a/src/main/java/io/geekidea/springbootplus/security/controller/LoginController.java b/src/main/java/io/geekidea/springbootplus/security/controller/LoginController.java
index 8453ce43..9256b18a 100644
--- a/src/main/java/io/geekidea/springbootplus/security/controller/LoginController.java
+++ b/src/main/java/io/geekidea/springbootplus/security/controller/LoginController.java
@@ -30,7 +30,7 @@
  * <p>
  *
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-15
  **/
 @Slf4j
diff --git a/src/main/java/io/geekidea/springbootplus/security/interceptor/JwtInterceptor.java b/src/main/java/io/geekidea/springbootplus/security/interceptor/JwtInterceptor.java
index 41982dac..b6cffc3d 100644
--- a/src/main/java/io/geekidea/springbootplus/security/interceptor/JwtInterceptor.java
+++ b/src/main/java/io/geekidea/springbootplus/security/interceptor/JwtInterceptor.java
@@ -37,7 +37,7 @@
  * <p>
  *  判断jwt token是否有效
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-22
  **/
 @Slf4j
diff --git a/src/main/java/io/geekidea/springbootplus/security/param/LoginParam.java b/src/main/java/io/geekidea/springbootplus/security/param/LoginParam.java
index 19b16516..c2af37e9 100644
--- a/src/main/java/io/geekidea/springbootplus/security/param/LoginParam.java
+++ b/src/main/java/io/geekidea/springbootplus/security/param/LoginParam.java
@@ -26,7 +26,7 @@
  * <p>
  *  登录参数
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-15
  **/
 @Data
diff --git a/src/main/java/io/geekidea/springbootplus/security/service/LoginService.java b/src/main/java/io/geekidea/springbootplus/security/service/LoginService.java
index 0d586396..db614ba2 100644
--- a/src/main/java/io/geekidea/springbootplus/security/service/LoginService.java
+++ b/src/main/java/io/geekidea/springbootplus/security/service/LoginService.java
@@ -27,7 +27,7 @@
  * <p>
  *  登录服务接口
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 public interface LoginService {
diff --git a/src/main/java/io/geekidea/springbootplus/security/service/impl/LoginServiceImpl.java b/src/main/java/io/geekidea/springbootplus/security/service/impl/LoginServiceImpl.java
index f172ea10..da481050 100644
--- a/src/main/java/io/geekidea/springbootplus/security/service/impl/LoginServiceImpl.java
+++ b/src/main/java/io/geekidea/springbootplus/security/service/impl/LoginServiceImpl.java
@@ -51,7 +51,7 @@
  * <p>
  *  登录服务实现类
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 @Api
diff --git a/src/main/java/io/geekidea/springbootplus/security/util/JwtUtil.java b/src/main/java/io/geekidea/springbootplus/security/util/JwtUtil.java
index 72a3d89d..ea32a451 100644
--- a/src/main/java/io/geekidea/springbootplus/security/util/JwtUtil.java
+++ b/src/main/java/io/geekidea/springbootplus/security/util/JwtUtil.java
@@ -34,7 +34,7 @@
  * <p>
  *  jwt工具类
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-15
  **/
 @Slf4j
diff --git a/src/main/java/io/geekidea/springbootplus/security/vo/ClientInfo.java b/src/main/java/io/geekidea/springbootplus/security/vo/ClientInfo.java
index 4d733217..ea01a519 100644
--- a/src/main/java/io/geekidea/springbootplus/security/vo/ClientInfo.java
+++ b/src/main/java/io/geekidea/springbootplus/security/vo/ClientInfo.java
@@ -24,7 +24,7 @@
  * <p>
  *  用户客户端信息对象
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 @Data
diff --git a/src/main/java/io/geekidea/springbootplus/security/vo/DeviceInfo.java b/src/main/java/io/geekidea/springbootplus/security/vo/DeviceInfo.java
index d2e18664..35cea7fd 100644
--- a/src/main/java/io/geekidea/springbootplus/security/vo/DeviceInfo.java
+++ b/src/main/java/io/geekidea/springbootplus/security/vo/DeviceInfo.java
@@ -24,7 +24,7 @@
  * <p>
  *  设备信息
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-24
  **/
 @Data
diff --git a/src/main/java/io/geekidea/springbootplus/security/vo/JwtTokenRedisVo.java b/src/main/java/io/geekidea/springbootplus/security/vo/JwtTokenRedisVo.java
index 70b30970..7c00da73 100644
--- a/src/main/java/io/geekidea/springbootplus/security/vo/JwtTokenRedisVo.java
+++ b/src/main/java/io/geekidea/springbootplus/security/vo/JwtTokenRedisVo.java
@@ -25,7 +25,7 @@
  * <p>
  *
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 @Data
diff --git a/src/main/java/io/geekidea/springbootplus/security/vo/LoginSysUserRedisVo.java b/src/main/java/io/geekidea/springbootplus/security/vo/LoginSysUserRedisVo.java
index 9c08f791..380f5049 100644
--- a/src/main/java/io/geekidea/springbootplus/security/vo/LoginSysUserRedisVo.java
+++ b/src/main/java/io/geekidea/springbootplus/security/vo/LoginSysUserRedisVo.java
@@ -25,7 +25,7 @@
  * <p>
  *  登录用户redis对象，后台使用
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-15
  **/
 @Data
diff --git a/src/main/java/io/geekidea/springbootplus/security/vo/LoginSysUserVo.java b/src/main/java/io/geekidea/springbootplus/security/vo/LoginSysUserVo.java
index 4de90bc0..8dad11c2 100644
--- a/src/main/java/io/geekidea/springbootplus/security/vo/LoginSysUserVo.java
+++ b/src/main/java/io/geekidea/springbootplus/security/vo/LoginSysUserVo.java
@@ -24,7 +24,7 @@
  * <p>
  *  登录用户对象，响应给前端
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-15
  **/
 @Data
diff --git a/src/main/java/io/geekidea/springbootplus/util/ClientInfoUtil.java b/src/main/java/io/geekidea/springbootplus/util/ClientInfoUtil.java
index add7d10c..3bbec9bd 100644
--- a/src/main/java/io/geekidea/springbootplus/util/ClientInfoUtil.java
+++ b/src/main/java/io/geekidea/springbootplus/util/ClientInfoUtil.java
@@ -28,7 +28,7 @@
  * <p>
  *  用户客户端信息工具类
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-24
  **/
 public class ClientInfoUtil {
diff --git a/src/main/java/io/geekidea/springbootplus/util/MapUtil.java b/src/main/java/io/geekidea/springbootplus/util/MapUtil.java
index 67c01ee0..ee08a540 100644
--- a/src/main/java/io/geekidea/springbootplus/util/MapUtil.java
+++ b/src/main/java/io/geekidea/springbootplus/util/MapUtil.java
@@ -23,7 +23,7 @@
  * <p>
  *  Map构建工具类
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-23
  **/
 public class MapUtil {
diff --git a/src/main/java/io/geekidea/springbootplus/util/PrintApplicationInfo.java b/src/main/java/io/geekidea/springbootplus/util/PrintApplicationInfo.java
index 16a87ce5..b5f2616b 100644
--- a/src/main/java/io/geekidea/springbootplus/util/PrintApplicationInfo.java
+++ b/src/main/java/io/geekidea/springbootplus/util/PrintApplicationInfo.java
@@ -25,7 +25,7 @@
  * <p>
  *  打印项目信息
  * </p>
- * @auth geekidea
+ * @author geekidea
  * @date 2019-05-08
  **/
 @Slf4j