Use delomboked sources for javadoc generation

This commit is contained in:
Adam
2021-01-19 16:51:50 -05:00
parent f8b407f79a
commit 19122e71c3
4 changed files with 42 additions and 2 deletions

14
cache/pom.xml vendored
View File

@@ -155,6 +155,20 @@
</execution>
</executions>
</plugin>
<!-- Delombok after generating ANTLR sources, if they are not available
delombok fails due to the missing classes -->
<plugin>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<!-- Include generated ANTLR sources in javadoc generation -->
<sourcepath>${project.build.directory}/delombok;${project.build.directory}/generated-sources/antlr4</sourcepath>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>

26
pom.xml
View File

@@ -200,6 +200,30 @@
<artifactId>maven-release-plugin</artifactId>
<version>2.5.3</version>
</plugin>
<plugin>
<groupId>org.projectlombok</groupId>
<artifactId>lombok-maven-plugin</artifactId>
<version>1.18.16.0</version>
<configuration>
<!-- Delomboked sources are only used for javadoc generation, and can be
skipped when javadoc is not being run. -->
<skip>${maven.javadoc.skip}</skip>
<sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
<!-- The default output directory is in generated-sources, which is
treated as a source root, even with addOutputDirectory false. So,
place it in top level build directory instead. -->
<outputDirectory>${project.build.directory}/delombok</outputDirectory>
<addOutputDirectory>false</addOutputDirectory>
</configuration>
<executions>
<execution>
<phase>generate-sources</phase>
<goals>
<goal>delombok</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
@@ -209,6 +233,8 @@
<source>8</source>
<!-- Fix Javadoc search feature to work without modules - https://stackoverflow.com/a/52603413 -->
<additionalJOption>--no-module-directories</additionalJOption>
<!-- Javadoc the delombok sources -->
<sourcepath>${project.build.directory}/delombok</sourcepath>
</configuration>
<!-- maven-release-plugin runs maven-javadoc-plugin:jar as one of its
release steps, so we will run it as well for the CI. Note this

View File

@@ -57,7 +57,7 @@ public abstract class Overlay implements LayoutableRenderableEntity
private boolean resettable = true;
/**
* Whether this overlay can be dragged onto other overlays & have
* Whether this overlay can be dragged onto other overlays &amp; have
* other overlays dragged onto it.
*/
@Setter(AccessLevel.PROTECTED)

View File

@@ -41,7 +41,7 @@ public abstract class OverlayPanel extends Overlay
protected final PanelComponent panelComponent = new PanelComponent();
/**
* Enables/disables automatic clearing of {@link this#getPanelComponent()} children after rendering (enabled by default)
* Enables/disables automatic clearing of {@link OverlayPanel#getPanelComponent()} children after rendering (enabled by default)
*/
private boolean clearChildren = true;