如何自定义 maven-java-doc 插件,仅更改 java 源代码部分将在完整生成的 java docfiles 中更新?
How to customize maven-java-doc plugin, that only changed java source code sections will be updated in the complete generated java docfiles?
我对 Apache Maven 中的 Maven javadoc 插件有疑问。如果将执行安装阶段,我当前的配置允许为我的 Maven 项目创建一个全新的 java 文档。如果我调用命令 "mvn clean install",java 文档文件将被完全删除(为此,我自定义了 Maven clean 插件)。并且在安装阶段,会再次生成java个doc文件!
有没有办法以这种方式自定义 java 文档插件,只有更改的 java 源代码部分才会在现有 java 文档中更新?并且不会再次生成完整的 java 文档?
我的maven-java文档配置:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9</version>
<configuration>
<noqualifier>all</noqualifier>
<reportOutputDirectory>myJavaDocOutputDirectory</reportOutputDirectory>
</configuration>
<executions>
<execution>
<id>create-myjavadoc</id>
<phase>install</phase>
<goals>
<goal>javadoc</goal>
</goals>
</execution>
</executions>
</plugin>
我的 maven-clean-plugin 配置:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<version>2.4.1</version>
<configuration>
<filesets>
<fileset>
<directory>target</directory>
<includes>
<include>**/*</include>
</includes>
<followSymlinks>false</followSymlinks>
</fileset>
<fileset>
<directory>MySourcefolder</directory>
<includes>
<include>**/*</include>
</includes>
<followSymlinks>false</followSymlinks>
</fileset>
</filesets>
</configuration>
</plugin>
也许不能在快照构建中生成 JavaDoc - 取决于您的要求。如果是这样,请为发布或特殊构建添加配置文件,其中包括 maven-javadoc-plugin 配置,并从默认 build/plugins 部分删除插件。当你想生成 JavaDoc 运行 配置文件时 "mvn clean install -P <profile>"。否则只需 运行 "mvn clean install" 即可避免生成 JavaDoc。这样的配置文件可能如下所示:
<profiles>
<profile>
<id>release-build</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9</version>
<configuration>
<noqualifier>all</noqualifier>
<reportOutputDirectory>myJavaDocOutputDirectory</reportOutputDirectory>
</configuration>
<executions>
<execution>
<id>create-myjavadoc</id>
<phase>install</phase>
<goals>
<goal>javadoc</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>
你可以运行它:"mvn clean install -P release-build"
我对 Apache Maven 中的 Maven javadoc 插件有疑问。如果将执行安装阶段,我当前的配置允许为我的 Maven 项目创建一个全新的 java 文档。如果我调用命令 "mvn clean install",java 文档文件将被完全删除(为此,我自定义了 Maven clean 插件)。并且在安装阶段,会再次生成java个doc文件!
有没有办法以这种方式自定义 java 文档插件,只有更改的 java 源代码部分才会在现有 java 文档中更新?并且不会再次生成完整的 java 文档?
我的maven-java文档配置:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9</version>
<configuration>
<noqualifier>all</noqualifier>
<reportOutputDirectory>myJavaDocOutputDirectory</reportOutputDirectory>
</configuration>
<executions>
<execution>
<id>create-myjavadoc</id>
<phase>install</phase>
<goals>
<goal>javadoc</goal>
</goals>
</execution>
</executions>
</plugin>
我的 maven-clean-plugin 配置:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-clean-plugin</artifactId>
<version>2.4.1</version>
<configuration>
<filesets>
<fileset>
<directory>target</directory>
<includes>
<include>**/*</include>
</includes>
<followSymlinks>false</followSymlinks>
</fileset>
<fileset>
<directory>MySourcefolder</directory>
<includes>
<include>**/*</include>
</includes>
<followSymlinks>false</followSymlinks>
</fileset>
</filesets>
</configuration>
</plugin>
也许不能在快照构建中生成 JavaDoc - 取决于您的要求。如果是这样,请为发布或特殊构建添加配置文件,其中包括 maven-javadoc-plugin 配置,并从默认 build/plugins 部分删除插件。当你想生成 JavaDoc 运行 配置文件时 "mvn clean install -P <profile>"。否则只需 运行 "mvn clean install" 即可避免生成 JavaDoc。这样的配置文件可能如下所示:
<profiles>
<profile>
<id>release-build</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9</version>
<configuration>
<noqualifier>all</noqualifier>
<reportOutputDirectory>myJavaDocOutputDirectory</reportOutputDirectory>
</configuration>
<executions>
<execution>
<id>create-myjavadoc</id>
<phase>install</phase>
<goals>
<goal>javadoc</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
</profiles>
你可以运行它:"mvn clean install -P release-build"