feat: javadoc

Author: weibiansanjue

.gitignore

@@ -1,4 +1,5 @@
 
+src/main/javadoc/overview.html
 src/main/resources/application-dev.yaml
 src/main/resources/static/help/
 node/

pom.xml

@@ -222,6 +222,48 @@
                 </executions>
             </plugin>
 
+            <!-- javadoc -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.5.0</version>
+                <configuration>
+                    <encoding>UTF-8</encoding>
+                    <charset>UTF-8</charset>
+                    <docencoding>UTF-8</docencoding>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>generate-javadoc-jar</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>${project.packaging}</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+
+            <!-- src/main/javadoc/overivew.md -> html -->
+            <plugin>
+                <groupId>com.ruleoftech</groupId>
+                <artifactId>markdown-page-generator-plugin</artifactId>
+                <version>2.4.0</version>
+                <executions>
+                    <execution>
+                        <phase>process-resources</phase>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <inputDirectory>${basedir}/src/main/javadoc</inputDirectory>
+                    <outputDirectory>${basedir}/src/main/javadoc</outputDirectory>
+                    <inputEncoding>UTF-8</inputEncoding>
+                    <outputEncoding>UTF-8</outputEncoding>
+                </configuration>
+            </plugin>
+
         </plugins>
     </build>
 

src/main/java/world/weibiansanjue/doctools/javadochub/JavadocHubApplication.java

@@ -3,6 +3,12 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
+/**
+ * Spring Boot 服务启动类.
+ *
+ * @author weibiansanjue
+ * @since 1.0.0
+ */
 @SpringBootApplication
 public class JavadocHubApplication {
 

src/main/java/world/weibiansanjue/doctools/javadochub/controller/JavadocController.java

@@ -15,7 +15,7 @@
 import java.io.IOException;
 
 /**
- * javadoc 获取.
+ * javadoc 获取控制器.
  *
  * @author weibiansanjue
  * @since 1.0.0

src/main/java/world/weibiansanjue/doctools/javadochub/controller/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * JavadocHub 对外接口.
+ *
+ * @author weibiansanjue
+ * @since 1.0.0
+ */
+package world.weibiansanjue.doctools.javadochub.controller;

src/main/java/world/weibiansanjue/doctools/javadochub/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * JavadocHub 主包.
+ * <p>JavadocHub 是可自部署的轻量级 javadoc 聚合、托管、查看服务，使用 SpringBoot 开发，
+ * 输入包 maven 坐标，即可查看对应文档。</p>
+ *
+ * @author weibiansanjue
+ * @since 1.0.0
+ */
+package world.weibiansanjue.doctools.javadochub;

src/main/java/world/weibiansanjue/doctools/javadochub/repository/Repository.java

@@ -29,7 +29,7 @@
 import java.util.stream.Collectors;
 
 /**
- * 仓库.
+ * 仓库操作.
  *
  * @author weibiansanjue
  * @since 1.0.0
@@ -60,7 +60,7 @@ public Repository() {
     }
 
     /**
-     * local artifact name list.
+     * 获取本地 artifact 名词集合.
      *
      * @author weibiansanjue
      * @param groupId group id
@@ -80,7 +80,7 @@ public List<String> artifact(String groupId) {
     }
 
     /**
-     * remote version list.
+     * 获取 maven 仓库中 javadoc 版本.
      *
      * @author weibiansanjue
      * @param groupId group id
@@ -112,7 +112,7 @@ public Versioning version(String groupId, String artifactId) {
     }
 
     /**
-     * download and discompress javadoc.
+     * 下载、解压 javadoc.jar.
      *
      * @author weibiansanjue
      * @param groupId group id

src/main/java/world/weibiansanjue/doctools/javadochub/repository/package-info.java

@@ -0,0 +1,7 @@
+/**
+ * 文档仓库、maven 仓库数据操作.
+ *
+ * @author weibiansanjue
+ * @since 1.0.0
+ */
+package world.weibiansanjue.doctools.javadochub.repository;

src/main/javadoc/overview.md

@@ -0,0 +1,7 @@
+
+<body>
+
+**JavadocHub 是可自部署的轻量级 javadoc 聚合、托管、查看服务，使用 SpringBoot 开发，
+输入包 maven 坐标，即可查看对应文档。**
+
+</body>