为所有模块设置备用JavaDoc位置的最佳方法?

时间:2013-01-15 06:10:52

标签: java maven javadoc maven-javadoc-plugin

我想为多模块maven项目中的所有模块设置备用JavaDoc位置。不幸的是,我必须依赖相对路径,或者使用像$ {basedir}这样的maven属性,因为这是一个关于颠覆的团队项目,并且绝对路径对于我们所有人来说都不一样。

最好的方法是什么?如果我有项目结构

parent
   sub1
   sub2
   sub3
      docs

我想将API放在sub3 / docs中,那么当父模块识别出与子模块不同的路径时,如何将所有模块指向输出sub3 / docs中的HTML文件?

提前致谢。

2 个答案:

答案 0 :(得分:1)

您希望尽可能少地污染您的项目构建,尤其是重复构建调整。相反,您最好创建一个单独的构建过程,该过程从所有项目中的标准位置组装javadoc输出,并将其发布到所需的位置。

答案 1 :(得分:0)

将以下内容添加到父pom中,并确保子pom没有定义自己的javadoc插件。

       <build>
       <plugins>
       <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.7</version>

            <configuration>
                <outputDirectory>${project.parent.basedir}/sub3</outputDirectory>
                <reportOutputDirectory>${project.parent.basedir}/sub3</reportOutputDirectory>
                <destDir>docs</destDir>
            </configuration>
        </plugin>
        </plugins>
        </build>