Page History

...

1. From the contents of the description tag of the @org.apache.xbean.Property annotation, for example:

   Code Block
   java java
   /** * @org.apache.xbean.Property description="here's my documentation!" */

   This approach works nice and makes it explicit where the documentation comes from. However, the documentation must appear on the same line: this is not good, as it discourages developers from writing detailed documentation and can lead to massively long lines in the code.
2. From the JavaDoc contents of the setter getter method. In the absence of a @org.apache.xbean.Property description tag, xbean will use the JavaDoc of the getter method. This is good, as it means you can have multi-line documentation commentary. However, the kind of documentation most coders put on a getter is typically quite basic, like "returns the delay": this is not going to be appropriate for an XML editting user who wants to know what they are setting.
3. From the JavaDoc contents of the getter setter method. This is arguably the best approach to use: here, you can write multi-line javadoc documentation, that matches the semantics of someone who wants to "set" some value and wants to know more about it.

...