Skip to content

Commit

Permalink
DRY: Centralise common Maven Javadoc configuration
Browse files Browse the repository at this point in the history
Signed-off-by: Alexander Kriegisch <[email protected]>
  • Loading branch information
kriegaex committed Feb 1, 2024
1 parent ecbe133 commit bce5e2d
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 44 deletions.
8 changes: 0 additions & 8 deletions aspectjmatcher/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -194,14 +194,6 @@
</goals>
<configuration>
<sourcepath>${project.build.directory}/unpacked-sources</sourcepath>
<!-- TODO: Include 'aj' package for ASM-renamed contained in aspectjtools? -->
<subpackages>org.aspectj</subpackages>
<!-- Deactivate doclint checks in order to suppress errors -->
<doclint>none</doclint>
<!-- Generate class use xref, making javadocs considerably bigger, but also more informative -->
<use>true</use>
<!-- FIXME: Why does it fail without this parameter? -->
<javadocVersion>8</javadocVersion>
</configuration>
</execution>
</executions>
Expand Down
8 changes: 0 additions & 8 deletions aspectjrt/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -192,14 +192,6 @@
</goals>
<configuration>
<sourcepath>${project.build.directory}/unpacked-sources</sourcepath>
<!-- TODO: Include 'aj' package for ASM-renamed contained in aspectjtools? -->
<subpackages>org.aspectj</subpackages>
<!-- Deactivate doclint checks in order to suppress errors -->
<doclint>none</doclint>
<!-- Generate class use xref, making javadocs considerably bigger, but also more informative -->
<use>true</use>
<!-- FIXME: Why does it fail without this parameter? -->
<javadocVersion>8</javadocVersion>
</configuration>
</execution>
</executions>
Expand Down
14 changes: 0 additions & 14 deletions aspectjtools/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -264,22 +264,8 @@
<goals>
<goal>jar</goal>
</goals>
<!--
FIXME: This configuration works with JDK 16, but throws errors on other JDK versions, e.g. 14. It looks as
if the Maven Javadoc plugin does not do a particularly good job applying the plugin settings in a way
making it work with different JDK javadoc tool versions. I am saying that, because when using the tool
directly on the console, it works with basic settings and the correct classpath.
-->
<configuration>
<sourcepath>${project.build.directory}/unpacked-sources</sourcepath>
<!-- TODO: Include 'aj' package for ASM-renamed contained in aspectjtools? -->
<subpackages>org.aspectj</subpackages>
<!-- Deactivate doclint checks in order to suppress errors -->
<doclint>none</doclint>
<!-- Generate class use xref, making javadocs considerably bigger, but also more informative -->
<use>true</use>
<!-- FIXME: Why does it fail without this parameter? -->
<javadocVersion>8</javadocVersion>
</configuration>
</execution>
</executions>
Expand Down
14 changes: 0 additions & 14 deletions aspectjweaver/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -265,22 +265,8 @@
<goals>
<goal>jar</goal>
</goals>
<!--
FIXME: This configuration works with JDK 16, but throws errors on other JDK versions, e.g. 14. It looks as
if the Maven Javadoc plugin does not do a particularly good job applying the plugin settings in a way
making it work with different JDK javadoc tool versions. I am saying that, because when using the tool
directly on the console, it works with basic settings and the correct classpath.
-->
<configuration>
<sourcepath>${project.build.directory}/unpacked-sources</sourcepath>
<!-- TODO: Include 'aj' package for ASM-renamed contained in aspectjtools? -->
<subpackages>org.aspectj</subpackages>
<!-- Deactivate doclint checks in order to suppress errors -->
<doclint>none</doclint>
<!-- Generate class use xref, making javadocs considerably bigger, but also more informative -->
<use>true</use>
<!-- FIXME: Why does it fail without this parameter? -->
<javadocVersion>8</javadocVersion>
</configuration>
</execution>
</executions>
Expand Down
16 changes: 16 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,22 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.2.0</version>
<!--
FIXME: This configuration works with JDK 16, but throws errors on other JDK versions, e.g. 14. It looks as
if the Maven Javadoc plugin does not do a particularly good job applying the plugin settings in a way
making it work with different JDK javadoc tool versions. I am saying that, because when using the tool
directly on the console, it works with basic settings and the correct classpath.
-->
<configuration>
<!-- TODO: Include 'aj' package for ASM-renamed contained in aspectjtools? -->
<subpackages>org.aspectj</subpackages>
<!-- Deactivate doclint checks in order to suppress errors -->
<doclint>none</doclint>
<!-- Generate class use xref, making javadocs considerably bigger, but also more informative -->
<use>true</use>
<!-- FIXME: Why does it fail without this parameter? -->
<javadocVersion>8</javadocVersion>
</configuration>
</plugin>
<plugin>
<groupId>org.asciidoctor</groupId>
Expand Down

0 comments on commit bce5e2d

Please sign in to comment.