delombok and Maven

[Sam Halliday]

Dear all,

I find the documentation for delombok to be impenetrable:

http://projectlombok.org/features/delombok.html

-> https://github.com/awhitford/lombok.maven

-> then where??

Can anybody help with:

1. what must I put in my pom.xml to delombok before creating Javadocs

2. is it possible to add documentation to my @Getter/@Setter fields and have this information show up in the Javadocs? Sometimes a one-line description of the parameter is all that is needed, and for tools like Paranamer (or IDEs), the parameter name in the Javadocs is critical.

Regards, Sam

[Reinier Zwitserloot]

We're ivy users. Maybe you can mail anthony or leave his github account a message?

javadoc + getters/setters is a known issue. If there's high demand we can make delombok emit javadoc with the parameter names. Feels like a violation of DRY though; what happens if you use -g to add debug symbols? Perhaps you should tell the makers of paranamer and such to just fetch the name from the debug info encoded in the class file if its there, if they don't already.

[Leon Blakey]

I know that I would very appreciate javadoc for getters and setters, and I know that there are many others that would like it to. Its been frustrating to have this idea constantly shot down by the lombok devs.

--
You received this message because you are subscribed to the Google
Groups group for http://projectlombok.org/
 
To post to this group, send email to project...@googlegroups.com
To unsubscribe from this group, send email to
project-lombo...@googlegroups.com
For more options, visit this group at
http://groups.google.com/group/project-lombok?hl=en

[Maaartin G]

On Monday, July 2, 2012 10:31:52 PM UTC+2, Reinier Zwitserloot wrote:

We're ivy users. Maybe you can mail anthony or leave his github account a message?

javadoc + getters/setters is a known issue. If there's high demand we can make delombok emit javadoc with the parameter names. Feels like a violation of DRY though; what happens if you use -g to add debug symbols? Perhaps you should tell the makers of paranamer and such to just fetch the name from the debug info encoded in the class file if its there, if they don't already.

Paranamer can use javadoc, or debug info, or both, or something else.

http://paranamer.codehaus.org/javadoc/com/thoughtworks/paranamer/JavadocParanamer.html

http://paranamer.codehaus.org/javadoc/com/thoughtworks/paranamer/BytecodeReadingParanamer.html

http://paranamer.codehaus.org/javadoc/com/thoughtworks/paranamer/AdaptiveParanamer.html

I'd suggest the javadoc generation to be controlled by @Accessors. IMHO, by default the accessors should get javadoc iff the underlying field has it.

[Reinier Zwitserloot]

That's fair enough.

[Sam Halliday]

I know, I wrote the JavadocParanamer ;-)

Most users of Paranamer actually use the ones which require magic to be inserted into class files. I wrote the Javadoc implementation as an alternative, when simply handed binaries and javadocs.

[Sam Halliday]

The docs here

  http://awhitford.github.com/lombok.maven/lombok-maven-plugin/index.html

are actually OK, but were very hard to find.

Does anybody know if it is possible to change the maven dir for delombok from src/main/lombok to just be src/main/java ? I don't want to re-arrange my source directories just for lombok, that's like saying I'm writing a completely different language. I like to think of Lombok as additional to Java, not replacement.

[Sam Halliday]

Nevermind, hidden in those docs was "lombok.sourceDirectory" which is easily reset with

        <lombok.sourceDirectory>${project.basedir}/src/main/java</lombok.sourceDirectory>

is there a reason, I should be aware of, why this isn't the default?