Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@Builder and javadoc #1033

Closed
kuipercm opened this issue Feb 24, 2016 · 2 comments · Fixed by #2008
Closed

@Builder and javadoc #1033

kuipercm opened this issue Feb 24, 2016 · 2 comments · Fixed by #2008

Comments

@kuipercm
Copy link

Hi guys,

Maybe I missed it, but if I create a class with an @builder annotation and I add javadoc to the fields, I find that this javadoc is not "transported" onto the builder methods. It would be very helpful if this were possible.

If it is possible, I'm probably doing something wrong. How can I get it right?

My code looks like this:

@AllArgsConstructor(access = AccessLevel.PRIVATE)
@Builder
@ToString
public class SomeClass {
    /** The name of the item */
    private final String name;
}

Cheers!

@kuipercm kuipercm changed the title @Build and javadoc @Builder and javadoc Feb 24, 2016
@jcayzac
Copy link

jcayzac commented Jul 4, 2018

This is a problem for us as well. Lombok is great for removing boilerplate but it shouldn't also remove all our documentation 😢

@keeperlink
Copy link

Same issue. Any plans to fix it?

rzwitserloot added a commit that referenced this issue Jan 8, 2019
…ch are deferred (during the javac run) until the end.

This already fixes the exotic-to-the-point-of-nonexistent bug where setter and wither compete to steal the `@param` off of the field’s javadoc. Next are to fix builder and setter/wither competing whilst bringing javadocs to `@Builder`.

Then for various other conflicts, we should defer removal of lombok imports and annotations until the end too.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants