如何使用Maven在目标(SVN-)服务器上创建Javadoc?

时间:2015-11-13 08:54:07

标签: java maven svn javadoc maven-javadoc-plugin

我想在我提交的后> >我的项目上创建我的项目的Javadoc文件,这意味着我希望服务器执行工作

我已查看maven-javadoc-plugin examples部分,但找不到合适的解决方案。 (也许我只是不理解它,我是Maven的新手。如果是这样,请宽容并向我解释)

重要的是要注意,我不希望Maven在每次构建时生成Javadoc,因为这将是一个很大的性能损失。我可以理解,<reporting/>应该是正确的位置。

我正在为Java EE开发人员和Maven 3使用eclipse IDE。

提前谢谢

1 个答案:

答案 0 :(得分:0)

一种可能的解决方案是创建一个post-commit hook,直接在命令行上调用javadoc实用程序。

提交后挂钩是一个成功提交后由SVN服务器执行的脚本。要创建提交后挂钩,请参阅this question(或this blog)。基本上,它归结为修改位于SVN服务器的post-commit.tmpl目录中的hooks模板脚本。

该脚本需要执行javadoc实用程序。它将取决于您当前的操作系统和SVN存储库目录结构,但假设Linux和一个名为myProject且包含父包com的项目,它可能是:

#!/bin/sh

REPOS="$1"
REV="$2"

/path/to/jdk/bin/javadoc -d ${REPOS}/myProject/target/javadoc -sourcepath "${REPOS}/myProject/src/main/java" -subpackages com

在此脚本中,REPOS指的是SVN存储库的位置。此挂钩将调用javadoc并告诉它将生成的Javadoc存储在targetmyProject的{​​{1}}个文件夹中,并带有公共子包src/main/java