Add @Documented to @JsonPropertyDescription - Feature request

[zoliszel]

Hi,

we are planning on using @JsonPropertyDescription to carry additional description into our generated schemas. Currently this annotation is not annotated with @<a href=http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Documented.html">Documented so the content is not visible in JavaDoc. We are currently using our custom one to come over this but I think this would be generally usefull to have (i.e. not duplicating comments). What do you think?
Regards,
Zoltan

[cowtowncoder]

Looks like @Documented is Java7 addition, unfortunately. I have no other objections, but unfortunately this one is problematic until we upgrade baseline JDK requirement.

I have been thinking of proposing Jackson 2.7 to move to Java 7, for what that is worth. The only question is whether we'd leave jackson-core (streaming) and perhaps jackson-annotations out; but that may not have many benefits.

[zoliszel]

If I am not mistaken it is available since 1.5: http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Documented.html (the link I posted was from 1.7 indeed :) )

[cowtowncoder]

Ah. I should have double-checked, javadocs indeed suggest 1.5.

If so, no objections, I can add it.

Do you think any other Jackson annotations should use this meta-annotation?

[zoliszel]

All other Jackson annotations are related to controlling the way serialization/de-serialization works which I do not think necessarily needs to be part of the JavaDoc for a class (unless explicitly added) - this is also in-line with JAXB annotations, they are not documented either.

JsonPropertyDescription some what special as it conveys documentation by definition and as such I do not see any compeling reason to add @Documented to anything but that one.

Thanks for adding this in.

Regards,
Zoltan