Generate XML Schema with documentation

Question

Is there a way to generate XML Schema(xsd) with documentation(<xsd:annotation> / <xsd:documentation>) from javadoc comments in classes? I know the reverse is possible (i.e generation classes with javadoc comments from xsd with comments).

Please advice.

Answer 1

Using the JAXBContext.generateSchema(SchemaOutputResolver) API it is not possible for Javadoc comments to be included in <xsd:documentation> sections. The reason for this is that there isn't any API available to introspect the Java class/field/property to get the information in the comments.

Answer 2

Yes, it is possible right now with the jaxb2-maven-plugin

http://www.mojohaus.org/jaxb2-maven-plugin/Documentation/v2.2/index.html

But the recommendation is to use the XmlType annotation, for me the javadocs were working only when i dont use the attribute name of this annotation. I think is a bug with the default javadoc renderer.

Answer 3

When javadoc doesn't work: How about an annotation (something like @XmlDocumentation(lang="en" content="..."))?