Add @Documented to @JsonPropertyDescription - Feature request about jackson-annotations HOT 4 CLOSED

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.

from jackson-annotations.

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 :) )

from jackson-annotations.

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?

from jackson-annotations.

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

from jackson-annotations.