47.2. Javadoc 옵션
47.2.1. 개요
Java API의 메타데이터가 Javadoc에서 제공하는 경우 일반적으로 옵션 없이 fromJavadoc 요소를 지정하는 것으로 충분합니다. 그러나 API 매핑에 전체 Java API를 포함하지 않으려는 경우 Javadoc 메타데이터를 필터링하여 콘텐츠를 사용자 지정할 수 있습니다. 즉, API 구성 요소 Maven 플러그인은 Javadoc 메타데이터를 통해 API 매핑을 생성하므로 Javadoc 메타데이터의 원하지 않는 부분을 필터링하여 생성된 API 매핑의 범위를 사용자 지정할 수 있습니다.
47.2.2. 구문
fromJavadoc 요소는 다음과 같이 선택적 하위 요소로 구성할 수 있습니다.
<fromJavadoc> <excludePackages>PackageNamePattern</excludePackages> <excludeClasses>ClassNamePattern</excludeClasses> <excludeMethods>MethodNamePattern</excludeMethods> <includeMethods>MethodNamePattern</includeMethods> <includeStaticMethods>[true|false]<includeStaticMethods> </fromJavadoc>
47.2.3. 범위
다음 추출에 표시된 대로 fromJavadoc 요소는 선택적으로 apis 요소의 자식으로 및/또는 api 요소의 자식으로 표시될 수 있습니다.
<configuration>
<apis>
<api>
<apiName>...</apiName>
...
<fromJavadoc>...</fromJavadoc>
</api>
<fromJavadoc>...</fromJavadoc>
...
</apis>
</configuration>
다음 범위에서 fromJavadoc 요소를 정의할 수 있습니다.
-
api요소의 자식으로 kafka- CryostatthefromJavadoc옵션은api요소에서 지정한 API 클래스에만 적용됩니다. -
apis요소의 자식으로 Cryostat-floatingthefromJavadoc옵션은 기본적으로 모든 API 클래스에 적용되지만api수준에서 재정의할 수 있습니다.
47.2.4. 옵션
다음 옵션은 fromJavadoc 의 하위 요소로 정의할 수 있습니다.
excludePackages-
API 매핑 모델에서 Java 패키지를 제외하기 위한 정규식(
java.util.regex구문)을 지정합니다. 정규식과 일치하는 모든 패키지 이름도 제외되며 제외된 클래스에서 파생된 모든 클래스도 무시됩니다. 기본값은javax?\.lang.\*입니다. excludeClasses-
API 매핑에서 API 기본 클래스를 제외하기 위한 정규식(
java.util.regex구문)을 지정합니다. 정규식과 일치하는 모든 클래스 이름은 제외되며 제외된 클래스에서 파생된 모든 클래스도 무시됩니다. excludeMethods-
API 매핑 모델에서 메서드를 제외하기 위한 정규식(
java.util.regex구문)을 지정합니다. includeMethods-
API 매핑 모델의 메서드를 포함하는 정규식(
java.util.regex구문)을 지정합니다. includeStaticMethods-
true인 경우 정적 메서드도 API 매핑 모델에 포함됩니다. 기본값은false입니다.
