如何使用 Maven 在目标(SVN-)服务器上创建 Javadoc?
How to create Javadoc on the target (SVN-) server using Maven?
我想创建我项目的 Javadoc 文件 on SVN-server right after 我提交了,这意味着 我希望服务器完成工作。
我已经查看了 maven-javadoc-plugin examples 部分,但找不到合适的解决方案。 (可能是我没看懂,我是Maven的新手,如果是,还请不吝赐教)
重要的是要注意,我不希望 Maven 在每次构建时生成 Javadoc,因为这会造成很大的性能损失。我可以弄清楚,<reporting/>
应该是正确的位置。
我正在为 Java EE 开发人员和 Maven 3 使用 eclipse IDE。
提前致谢
一个可能的解决方案是直接在命令行上创建一个 post-commit hook that invokes the javadoc
实用程序。
post-commit hook 是一个脚本,在成功提交后由 SVN 服务器执行。要创建 post-提交挂钩,请参阅 this question (or this blog)。基本上,它归结为修改位于 SVN 服务器 hooks
目录中的 post-commit.tmpl
模板脚本。
脚本需要执行 javadoc
实用程序。这将取决于您当前的 OS 和 SVN 存储库目录结构,但假设 Linux 和一个名为 myProject
的项目及其父包 com
,它可能是:
#!/bin/sh
REPOS=""
REV=""
/path/to/jdk/bin/javadoc -d ${REPOS}/myProject/target/javadoc -sourcepath "${REPOS}/myProject/src/main/java" -subpackages com
在此脚本中,REPOS
指的是 SVN 存储库的位置。此挂钩将调用 javadoc
并告诉它将生成的 Javadoc 存储在 myProject
的 target
文件夹内 src/main/java
内的所有 类 与公共子包 com
.
我想创建我项目的 Javadoc 文件 on SVN-server right after 我提交了,这意味着 我希望服务器完成工作。
我已经查看了 maven-javadoc-plugin examples 部分,但找不到合适的解决方案。 (可能是我没看懂,我是Maven的新手,如果是,还请不吝赐教)
重要的是要注意,我不希望 Maven 在每次构建时生成 Javadoc,因为这会造成很大的性能损失。我可以弄清楚,<reporting/>
应该是正确的位置。
我正在为 Java EE 开发人员和 Maven 3 使用 eclipse IDE。
提前致谢
一个可能的解决方案是直接在命令行上创建一个 post-commit hook that invokes the javadoc
实用程序。
post-commit hook 是一个脚本,在成功提交后由 SVN 服务器执行。要创建 post-提交挂钩,请参阅 this question (or this blog)。基本上,它归结为修改位于 SVN 服务器 hooks
目录中的 post-commit.tmpl
模板脚本。
脚本需要执行 javadoc
实用程序。这将取决于您当前的 OS 和 SVN 存储库目录结构,但假设 Linux 和一个名为 myProject
的项目及其父包 com
,它可能是:
#!/bin/sh
REPOS=""
REV=""
/path/to/jdk/bin/javadoc -d ${REPOS}/myProject/target/javadoc -sourcepath "${REPOS}/myProject/src/main/java" -subpackages com
在此脚本中,REPOS
指的是 SVN 存储库的位置。此挂钩将调用 javadoc
并告诉它将生成的 Javadoc 存储在 myProject
的 target
文件夹内 src/main/java
内的所有 类 与公共子包 com
.