使用Tomcat的Maven项目中JavaDoc文件的最佳位置是什么?

时间:2017-04-21 07:41:23

标签: maven tomcat pom.xml javadoc

我正在使用Travis CI定期将Maven项目部署到Tomcat服务器。我的项目是一个Web应用程序,因此我已将... <packaging>war</packaging> ... 配置为构建WAR文件,而不是JAR:

target/site/apidocs

使用Maven,我可以为我的项目生成一个包含所有JavaDoc文件的目录; Maven将它们放在mvn site目录中。但是,当我部署我的项目时,Travis没有执行任何pom.xml阶段,因此我没有在服务器上安装我的JavaDoc。

我应该编辑我的src以便Maven将JavaDoc文件放在target目录中的某个位置(而不是docs/),或者是否有办法将JavaDoc文件与WAR文件?我以为我可以在src/main/webapp/内创建一个src目录。具体来说:是好的做法&#34;在target而不是 MockMultipartFile phenoFile = new MockMultipartFile("file", "size_trans_20160419_KM2.txt", ContentType.TEXT_PLAIN.toString(), new FileInputStream("src/test/resources/size_trans_20160419_KM2.txt")); 生成我的JavaDoc?如果没有,我怎么能有一个包含我的JavaDoc的WAR文件?

你认为最好的做法是什么?

我已经知道如何生成包含我的JavaDoc文件的独立JAR(请参阅here),但这不是我正在寻找的。

1 个答案:

答案 0 :(得分:0)

使用网站插件https://maven.apache.org/plugins/maven-site-plugin/和javdoc插件https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html

将以下内容添加到您的pom.xml

   <reporting>
                <plugins>
                        <plugin>
                                <groupId>org.apache.maven.plugins</groupId>
                                <artifactId>maven-javadoc-plugin</artifactId>
                                <configuration>
                                        <links>
                                                <link>http://commons.apache.org/lang/api</link>
                                                <link>http://java.sun.com/j2se/1.5.0/docs/api</link>
                                                <link>http://this-one-will-not-work</link>
                                        </links>
                                </configuration>
                        </plugin>
                </plugins>
    </reporting>

然后mvn site:site您的文档将在目标/站点中,您也可以部署它。