[seam-dev] annotations in JavaDoc

Max Rydahl Andersen max.andersen at redhat.com
Sun Sep 28 14:39:26 EDT 2008

someone should write a javaagent that tweaks the classloading and add  
@Documented to all annotations (maybe even
have an include/exclude list ;)


> After a long commute, it hit me that I have the source code to the
> persistence API and I can make the annotations anything I want. With
> some small enhancements, I now have my mappings documented in my
> JavaDoc, so the immediate problem is solved.
> I was thinking, though, that the @Documented annotation is really
> pretty arbitrary. Whether or not to document the annotation is very
> specific to the context in which you are generating the JavaDoc.
> Frankly, the @Documented annotation should just be a hint and the
> javadoc tool should have some sort of option for controlling which
> annotations are included or excluded as an override.
> I will mention my recommendation to the EG.
> -Dan
> On Wed, Sep 24, 2008 at 9:34 AM, Emmanuel Bernard
> <emmanuel at hibernate.org> wrote:
>> Provide the feedback to the JPA EG :)
>> --
>> Emmanuel Bernard
>> http://in.relation.to/Bloggers/Emmanuel |  
>> http://blog.emmanuelbernard.com |
>> http://twitter.com/emmanuelbernard
>> Hibernate Search in Action (http://is.gd/Dl1)
>> On  Sep 24, 2008, at 05:58, Dan Allen wrote:
>>> Does anyone know how to force the javadoc tool to include annotations
>>> even if they are not marked as @Documented? Graciously the Seam
>>> project marked most (if not all) annotations as @Documented, but in
>>> JPA, none of them are marked this way. Thus, it is difficult to share
>>> browse mappings w/o looking at the code.
>>> -Dan
>>> --
>>> Dan Allen
>>> Software consultant | Author of Seam in Action
>>> http://mojavelinux.com
>>> http://mojavelinux.com/seaminaction
>>> NOTE: While I make a strong effort to keep up with my email on a daily
>>> basis, personal or other work matters can sometimes keep me away
>>> from my email. If you contact me, but don't hear back for more than a
>>> week,
>>> it is very likely that I am excessively backlogged or the message was
>>> caught in the spam filters. Please don't hesitate to resend a message  
>>> if
>>> you feel that it did not reach my attention.
>>> _______________________________________________
>>> seam-dev mailing list
>>> seam-dev at lists.jboss.org
>>> https://lists.jboss.org/mailman/listinfo/seam-dev


More information about the seam-dev mailing list