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 的 子元素：