From 3454de1a732e5a5941ecfdc0677b352608fe9490 Mon Sep 17 00:00:00 2001 From: richie Date: Wed, 25 Sep 2019 13:58:50 +0800 Subject: [PATCH] =?UTF-8?q?javadoc=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pom.xml | 9 +++++++++ readme.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/pom.xml b/pom.xml index a1535fe..e749752 100644 --- a/pom.xml +++ b/pom.xml @@ -160,6 +160,15 @@ + + org.apache.maven.plugins + maven-javadoc-plugin + 2.9.1 + + target + javadocs + + diff --git a/readme.md b/readme.md index 121545e..2d88c4b 100644 --- a/readme.md +++ b/readme.md @@ -38,6 +38,7 @@ SessionKit#getSession(@NotNull String sessionID); ## 使用方法 +### 生成运行时依赖jar包 先使用maven打包,执行下面的命令(跳过单元测试) ``` @@ -46,6 +47,14 @@ SessionKit#getSession(@NotNull String sessionID); 会在target目录下获得一个形如finekit-10.0-20190815.jar名字jar包,直接作为插件依赖jar包即可。 +### 生成javadoc文档 +执行maven命令 + +``` +mvn javadoc:javadoc +``` +即可在target/javadocs目录下获取到javadoc文档。 + ## 如何判断插件中调用的API需要增加到FineKit中 最简单的原则: