maven - 我可以使用Maven JavaDoc插件(2.7版)excludePackageNames属性排除软件包,但不排除其子软件包吗?

标签 maven javadoc

我有一组要为其生成Javadoc的类,其中一些我想从已发布的Javadoc中排除。结构如下:

com.company.package.classA
com.company.package.classB
com.company.package.subpackage.classC
com.company.package.subpackage.classD


我想排除“包装”中的所有类,而将“子包装”中的所有类包括在内。设置:

<excludePackageNames>com.company.package</excludePackageNames>


排除包下面的所有子包。

除了重组代码之外,还有什么办法可以做到这一点?

最佳答案

您可以使用
maven-javadoc-plugin为您做。

2.7及更高版本支持此功能。

例:

<plugin>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.8.1</version>
    <executions>
      <execution>
        <id>javadoc-jar</id>
        <phase>package</phase>
        <goals>
          <goal>jar</goal>
        </goals>
        <configuration>
          <!-- switch on dependency-driven aggregation -->
          <includeDependencySources>true</includeDependencySources>

          <dependencySourceExcludes>
            <!-- exclude ONLY commons-cli artifacts -->
            <dependencySourceExclude>commons-cli:*</dependencySourceExclude>
          </dependencySourceExcludes>
        </configuration>
      </execution>
    </executions>
  </plugin>




     <configuration>
          <!-- switch on dependency-driven aggregation -->
          <includeDependencySources>true</includeDependencySources>

          <dependencySourceIncludes>
            <!-- include ONLY dependencies I control -->
            <dependencySourceInclude>org.test.dep:*</dependencySourceInclude>
          </dependencySourceIncludes>
     </configuration>

关于maven - 我可以使用Maven JavaDoc插件(2.7版)excludePackageNames属性排除软件包,但不排除其子软件包吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/11404618/

相关文章:

java - 如何从另一个文件加载maven依赖项?

java - 使用 Spring @Profile 加载 log4j2 xml 配置而不是 maven <profile>

java - Maven 无法识别本地存储库中的 Jar

java - 为外部库编写 JavaDocs

java - 在 Maven 尝试解析它之前,将本地 jar 依赖项作为生命周期的一部分安装

java - 强制动态绑定(bind)

java - 有没有Java注解来生成参数文档?

java - 来自命令行的 Eclipse Javadoc 编译器警告

java - 类上的@param javadoc

jboss 服务器的 Java 文档?