[BUG] JavaDoc for generated getter in nested inner class cannot be linked to from outer class

[mirabilos]

Describe the bug

I’m getting JavaDoc errors trying to link to an @Getter from a nested inner class.

To Reproduce

TestJavaDoc.java.zip

Running mvn org.apache.maven.plugins:maven-javadoc-plugin:jar@attach-javadocs results in:

[ERROR] /…/src/main/java/TestJavaDoc.java:22: error: reference not found
[ERROR]  * @return result; remember to call {@link Result#isValid()} before using!
[ERROR]                                            ^

My language level is 8 here, but I tried it with 11 as well (using maven-javadoc-plugin 3.2.0 with JDK 11 from Debian sid).

That {@link … was auto-completed by IntelliJ with the latest Lombok plugin installed, by the way, and the reference is correct when Ctrl-Q’d within IntelliJ.

Expected behavior

No JavaDoc error, the project compiles

Version info (please complete the following information):

• Lombok version:
  <lombok.version>1.18.12</lombok.version>

• Platform
  $ javadoc --version
  javadoc 11.0.7

Additional context

Just ask for what you need.

[Rawi01]

Lombok does not run during javadoc creation, thats why it can not find the getter. The recommended solution for this seems to be using delombok first and running javadoc on the generated result (https://projectlombok.org/features/all#running-delombok). If you don't care about the generated stuff you can also disable the javadoc checks.

[mirabilos]

@Rawi01 that’s not as easy as it sounds.

I now managed to do the delomboking only for Javadoc but now I have to add @return to the Javadoc of the slots because these are not synthetically generated, which IntelliJ automatically removes again…