JavaDoc does not see @Data generated methods

[lombokissues]

JavaDoc does not see @Data generated methods

[lombokissues]

👤 jacek99   🕗 Sep 02, 2009 at 14:36 UTC

What steps will reproduce the problem?

1. Create a @ Data POJO with some fields
2. In Maven, run mvn javadoc:javadoc

What is the expected output? What do you see instead?

@ Data - generated getters/setters should show in the Javadoc.
Instead nothing shows, the Javadoc shows a class with no methods at all.

What version of the product are you using? On what operating system?

0.8.3, Linux.

[lombokissues]

👤 reinierz   🕗 Sep 03, 2009 at 00:18 UTC

WOW! We figured this out well before we delivered the first working prototype of lombok and thought people
would throw a FIT when they realized their methods would not show up in javadoc.

It took THIS long for someone to notice. Much kudos, respect, and all such credits to you, sir, for finding
this issue. Though, I must conclude clearly nobody gives a crud about javadoc if it took this long for folks to
notice.

It's been on our radar for some time, and we have 2 different ideas on how to fix it. Both of them are
somewhat complicated, so it's not critical priority.

Can you do me a favour and check if you can specify the doclet to use for generating javadoc in your maven
pom.xml file? One of our two strategies involves using a doclet, the other will definitely require some fancy
footwork in your maven pom to make tick. (new plugin, most likely). Hence our preference for the doclet
solution, but it would help if we were sure that would in fact make maven-based javadoc building easy.

Thanks for checking!

[lombokissues]

👤 jacek99   🕗 Sep 03, 2009 at 01:16 UTC

I only found out cause I was using the Javadoc as a high level overview for some new
APIs and realized they're all empty! :-)

Quick search on Google gave me the answer you seek:

http://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-doclet.html

[lombokissues]

👤 reinierz   🕗 Jul 19, 2010 at 14:52 UTC

We solved this quite a while ago via the delombok tool. Technically we should, for maven, put a plugin together, maybe. As none of us are maven gurus we're going to be optimistic and rely on our users to perhaps post a solution specifically for maven :P

NB: There's also an ant task, which I think you can run from maven, no?

More info here: https://projectlombok.org/features/delombok.html

[lombokissues]

End of migration