47.2. javadoc 选项

概述

如果您的 Java API 元数据由 Javadoc 提供，则通常足以指定没有选项的 fromJavadoc 元素。但是，如果您不想在 API 映射中包含整个 Java API，您可以过滤 Javadoc 元数据来自定义内容。换句话说，因为 API 组件 Maven 插件通过迭代 Javadoc 元数据来生成 API 映射，因此可以通过过滤 Javadoc 元数据不需要的部分来自定义生成的 API 映射的范围。

语法

fromJavadoc 元素可以使用可选的子元素配置，如下所示： 

<fromJavadoc>
  <excludePackages>PackageNamePattern</excludePackages>
  <excludeClasses>ClassNamePattern</excludeClasses>
  <excludeMethods>MethodNamePattern</excludeMethods>
  <includeMethods>MethodNamePattern</includeMethods>
  <includeStaticMethods>[true|false]<includeStaticMethods>
</fromJavadoc>

影响范围

如以下提取所示，fromJavadoc 元素可以选择性地显示为 apis 元素和/或作为 api 元素子元素的子级： 

<configuration>
  <apis>
    <api>
      <apiName>...</apiName>
      ...
      <fromJavadoc>...</fromJavadoc>
    </api>
    <fromJavadoc>...</fromJavadoc>
    ...
  </apis>
</configuration>

您可以在以下范围中定义 fromJavadoc 元素：

  • 作为 来自Javadoc 选项的 api 元素的子级 ，仅适用于 api 元素指定的 API 类。
  • 作为 apis 元素 来自Javadoc 选项的子级 ，默认应用于所有 API 类，但可以在 api 级别被覆盖。

选项

以下选项可以定义为 来自Javadoc 的子元素：

excludePackages
指定正则表达式(java.util.regex 语法)，用于从 API 映射模型中排除 Java 软件包。所有与正则表达式匹配的软件包名称都将被排除，并且从 排除类派生的所有类都将被忽略。默认值为 javax?\.lang.\*。
excludeClasses
指定正则表达式(java.util.regex 语法)，用于排除 API 映射中的 API 基本类。所有与正则表达式匹配的类名称都将被排除； 从排除类派生的所有类都将被忽略。
excludeMethods
指定正则表达式(java.util.regex 语法)，用于排除 API 映射模型中的方法。
includeMethods
指定正则表达式(java.util.regex 语法)，其中包含来自 API 映射模型的方法。
includeStaticMethods
如果为 true，则 API 映射模型中也会包含静态方法。默认为 false。