如何用maven-site-plugin生成含类Javadoc不含测试Javadoc的项目站点
解决方案
要生成包含主类Javadoc但排除测试Javadoc的Maven项目站点,只需修改maven-javadoc-plugin的配置,跳过测试Javadoc的生成即可:
修改后的完整POM配置
<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>4.0.0-M8</version> </plugin> </plugins> </build> <reporting> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> <configuration> <outputDirectory>target/javadoc</outputDirectory> <reportOutputDirectory>target/javadoc</reportOutputDirectory> <javadocExecutable>${java.home}/bin/javadoc</javadocExecutable> <!-- 跳过测试Javadoc的生成 --> <skipTestJavadoc>true</skipTestJavadoc> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jxr-plugin</artifactId> <version>3.3.0</version> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-project-info-reports-plugin</artifactId> <version>3.4.3</version> </plugin> </plugins> </reporting>
简化执行命令
无需单独指定javadoc:javadoc目标,site目标会自动触发Javadoc报告的生成,执行以下命令即可:
mvn clean install site -U
补充说明
如果只是想允许测试Javadoc为空而不失败(而非完全跳过),可以在maven-javadoc-plugin的配置中添加:
<testFailOnError>false</testFailOnError>
但直接跳过测试Javadoc生成是更直接解决当前问题的方式。
内容的提问来源于stack exchange,提问作者PatPanda
相关产品推荐
相关产品推荐

