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.

score 2 · Accepted Answer · answered Mar 09 '11 at 14:09

2

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.

answered Mar 09 '11 at 14:09

bdoughan

147,609
23
300
400

so jaxb doesn't support the above feature? – Sahil Dave Mar 10 '11 at 14:29
Right, as the Java language does not support the means to provide such a feature. – bdoughan Mar 10 '11 at 14:32

score 1 · Answer 2 · answered Mar 11 '11 at 12:40

1

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

answered Mar 11 '11 at 12:40

Walter van Iterson

11
1

If such annotation is possible, then it sounds like a good idea to me – Julien Oct 01 '15 at 15:00

score 0 · Answer 3 · answered Aug 17 '16 at 12:45

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.

Generate XML Schema with documentation

3 Answers3

Linked