Browse Source

javadoc文档

master
richie 5 years ago
parent
commit
3454de1a73
  1. 9
      pom.xml
  2. 9
      readme.md

9
pom.xml

@ -160,6 +160,15 @@
</archive> </archive>
</configuration> </configuration>
</plugin> </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<configuration>
<reportOutputDirectory>target</reportOutputDirectory>
<destDir>javadocs</destDir>
</configuration>
</plugin>
</plugins> </plugins>
<resources> <resources>
<resource> <resource>

9
readme.md

@ -38,6 +38,7 @@ SessionKit#getSession(@NotNull String sessionID);
## 使用方法 ## 使用方法
### 生成运行时依赖jar包
先使用maven打包,执行下面的命令(跳过单元测试) 先使用maven打包,执行下面的命令(跳过单元测试)
``` ```
@ -46,6 +47,14 @@ SessionKit#getSession(@NotNull String sessionID);
会在target目录下获得一个形如finekit-10.0-20190815.jar名字jar包,直接作为插件依赖jar包即可。 会在target目录下获得一个形如finekit-10.0-20190815.jar名字jar包,直接作为插件依赖jar包即可。
### 生成javadoc文档
执行maven命令
```
mvn javadoc:javadoc
```
即可在target/javadocs目录下获取到javadoc文档。
## 如何判断插件中调用的API需要增加到FineKit中 ## 如何判断插件中调用的API需要增加到FineKit中
最简单的原则: 最简单的原则:

Loading…
Cancel
Save