users@jaxb.java.net

Re: XSD annotation/documentation to Javadoc request

From: Ed Mooney <Ed.Mooney_at_sun.com>
Date: Wed, 25 Jun 2003 07:46:54 -0400

Hi Gary,

You might be able to do what you want with a javadoc customization:

http://java.sun.com/webservices/docs/1.1/tutorial/doc/JAXBusing4.html#wp148671

Regards,
--
Ed Mooney         |Sun Microsystems, Inc.|Time flies like
Java Web Services |UBUR02-201            |an arrow, but
Ed.Mooney_at_Sun.COM |1 Network Drive       |fruit flies like
781-442-0459      |Burlington, MA  01803 |a banana. Groucho
Gary Gregory wrote:
> Hello,
>
> It would be quite helpful if XSD annotations would show up as Javadoc
> comments.
>
> For example, the following:
>
>             <xs:attribute name="maxConnectionsPerHost"
> type="cics:positiveShort" use="optional" default="2">
>                 <xs:annotation>
>                     <xs:documentation>Sets the maximum number of
> connections allowed for a given HostConfiguration. Per RFC 2616 section
> 8.1.4, this value defaults to 2.</xs:documentation>
>
>                 </xs:annotation>
>             </xs:attribute>
>
> Would show up as:
>
> /**
>   * Sets the maximum number of connections allowed for a
>   * given HostConfiguration. Per RFC 2616 section 8.1.4,
>   * this value defaults to 2.
>   */
>
> I've formatted this so it fits nicely in an email message but I think
> the format should not be changed from what is in the
> annotation/documentation element.
>
> The reason I bring this is up is that some tools like XMLSpy support
> this scheme to document XSDs, which is how we document our XSDs.
>
> Gary
>