[Simple-support] Have Simple annotations included in Javadoc documents
Brought to you by:
niallg
|
From: Max S. <ma...@se...> - 2013-03-14 12:22:27
|
Hi there,
I was creating a Javadoc documentation of my current project. I then
noticed, that the Simple annotations do not appear in the Javadoc docs.
I then searched if there is any setting that I can tweak to have Javadoc
include the annotations...
Sadly the only way is that the annotation definitions itselves have to
be marked with "@Documented". Example:
--- File "org/simpleframework/xml/Root.java" ---
[...]
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Root {
[...]
--- File "org/simpleframework/xml/Root.java" ---
After I compiled Simple with this change the Javadoc created the
following output:
--- Some Javadoc output ---
[...]
@Root(name="rootElementName")
public class myRootClass
extends BasicMessage
[...]
--- Some Javadoc output ---
So, could you please consider to mark all notations in your official
version with that annotation? Or is there any reason not to do so?
Best regards
Max Senft
|