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

  • 作为 api 元素 containerruntime-Featurethe fromJavadoc 选项的子项 ，仅适用于 api 元素指定的 API 类。
  • 作为 apis 元素 的子项 将 fromJavadoc 选项应用到所有 API 类，但可以在 api 级别覆盖。

选项

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

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