Javadoc not generated for Lombok getter and setter

javadoc lombok
Egemen picture Egemen · Aug 28, 2015 · Viewed 11.3k times · Source

I am having a problem with generating Javadoc for Lombok getters and setters. I have tried both suggestions here. An example field and its text are as follows:

/**  
 *  Identifier of the client
 * 
 *  @param clientID changes the id of the client 
 *  @return id of the client
 */
@Getter @Setter private Integer clientID;

However, I see neither the getter nor the setter in the generated Javadoc. I am using 'protected' visibility on Eclipse (Project -> Generate Javadoc...). My Lombok version is 1.12.4. Any suggestions?

Answer

Roel Spilker picture Roel Spilker · Aug 31, 2015

The javadoc feature does not work in the eclipse javadoc view or hovers. You can generate the javadoc by running delombok on the code first and then run the javadoc compiler, as is hinted on the feature page near the bottom.

Disclosure: I am a Lombok developer.

Related questions

How to reference a method in javadoc?

How can I use the @link tag to link to a method? I want to change: /** * Returns the Baz object owned by the Bar object owned by Foo owned by this. * A convenience method, equivalent to getFoo().getBar().getBaz() * @return …

Read More
How can I generate Javadoc comments in Eclipse?

Is there a way to generate Javadoc comments in Eclipse? If so, what is it?

Read More
How to generate Javadoc HTML files in Eclipse?

I have written Javadoc style comments like this in my project's code: /** * Description... * * @param ... * @return ..... */ How can I generate Javadoc HTML files using the Eclipse IDE?

Read More