users@jaxb.java.net

Re: Schema Annotations/Documentation to Javadoc

From: Michael Vorburger <mike_at_vorburger.ch>
Date: Thu, 1 Jun 2006 21:04:38 +0200

On 6/1/06, Kohsuke Kawaguchi <Kohsuke.Kawaguchi_at_sun.com> wrote:
> Michael Vorburger wrote:
> > It would be "handy" (not Spec required, I understand) if normal Schema
> > Annotations would be turned into JavaDoc of classes, getters/setters
> > and enums etc. (For example the JAX-RPC Code Generator in Axis1 did
> > this.)
>
> JAXB already does this to some extent.

Y... ok, right, a complexType's annotation/documentation becomes the
JavaDoc of the class, fine, but only there (right?), not in...

> If you find cases where it doesn't work as you expected,

.. not the same complexType's sequence/element* documentation (which
I'd think you'd expect on the respective getters/setters, instead of
that pretty useless "Gets the value of the ... property."), nor a
simpleType's annotation/documentation that turns into a @XmlEnum
public enum, where one would expect both JavaDoc of the class as well
as the individual enum values, from the
simpleType/restriction/enumeration/annotation/documentation.
(Additionally maybe putting schema/annotation/documentation into
package-info.java as JavaDoc; although not sure how to deal with one
namespace schema in several .xsd... not sure how that looks in XSOM by
the time you process this?)

> please file a bug, hopefully with your schema, and we'll take a look.

Can I just copy/paste the above or do you need full example schema?
This Email enough?

I'm not familiar with the development process of JAXB on java.net -
once get a chance to take a look and implement, does this then go into
some 2.1 and I can't see it for quite a while, or are there
intermediate builds (or can I build it?) to test it out relatively
soon and give you feedback etc. ? Just asking!


> > Reading a thread from last year at
> > https://jaxb.dev.java.net/servlets/ReadMsg?list=users&msgNo=4328 makes
> > one think that's the case... is there a special option required to
> > turn this on? It doesn't seem to work in all cases (using
> > jaxb-ri-20060426)... unless I'm not getting it.
> >
> > How I'd imaging this to work is that IFF a jaxb:javadoc is available,
> > then that takes precedence over the xsd:annotation/documentation, as
> > the former is more specific (some HTML allowed, JavaDoc @see etc.
> > stuff) but if there isn't, then xsd:annotation would be used wherever
> > available.
> >
> > Thanks!
> >
>
>
> --
> Kohsuke Kawaguchi
> Sun Microsystems kohsuke.kawaguchi_at_sun.com
>
>
>


-- 
Michael Vorburger
  MAIL: mike_at_vorburger.ch
  HOME: http://www.vorburger.ch/  (NEW!)
  POTS: +41 (78) 805 55 41