How to make generated classes contain Javadoc from XML Schema documentation

by

I’ve never been able to get regular xsd:documentation to be placed in the java source except if and only if it was a Complex Type. Documentation for elements, simple types,
etc are ignored.

So, I end up using jxb:javadoc. To do so, include the definition of xmlns:jxb="http://java.sun.com/xml/ns/jaxb" in your <xsd:schema> element.

Add a child to <xsd:complexType> or <xsd: element> or <xsd:attribute>:

<xsd:annotation><xsd:appinfo><jxb:XXX><jxb:javadoc>
  This is my comment for a class/property
</jxb:javadoc></jxb:XXX></xsd:appinfo></xsd:annotation>

Where XXX is either “class” or “property”.

For a package you write a child to xsd:schema

<xsd:annotation><xsd:appinfo><jxb:schemaBindings><jxb:package name="com.acme"><jxb:javadoc>
  This is my comment for a package
</jxb:javadoc></jxb:package></jxb:schemaBindings></xsd:appinfo></xsd:annotation>

Writing HTML document requires bracketing with <![CDATA[ --- ]]>

(EDIT: While writing my answer, the question has been edited by the OP so I’m updating it accordingly)

In my case, javadoc was the only target so it was acceptable to use jxb:javadoc. But your update makes perfect sense and, actually, I totally agree with you. Sadly, I never found an ideal solution for the situation you describe (so I’ll follow this question very carefully). Maybe you could use something like xframe to generate documentation from xsd:documentation, but this doesn’t answer the question.

More Related Contents:

  1. No @XmlRootElement generated by JAXB
  2. Generating a JAXB class that implements an interface
  3. How to generate a Java class which implements Serializable interface from xsd using JAXB?
  4. Inserting code with XJC+xsd+jxb using the options ” -Xinject-code -extension “
  5. How generate XMLElementWrapper annotation with xjc and customized binding
  6. How to deal with JAXB ComplexType with MixedContent data?
  7. JAXB, XJC -> create multiple class files
  8. JAXB: How to ignore namespace during unmarshalling XML document?
  9. How to change webservice url endpoint?
  10. Maven is not working in Java 8 when Javadoc tags are incomplete
  11. Eclipse: Attach source/javadoc to a library via a local property
  12. Difference of Maven JAXB plugins
  13. JAXB :Need Namespace Prefix to all the elements
  14. JAXB Mapping cyclic references to XML
  15. Java/JAXB: Unmarshall Xml to specific subclass based on an attribute
  16. JAX-WS client : what’s the correct path to access the local WSDL?
  17. java: Rpc/encoded wsdls are not supported in JAXWS 2.0
  18. /** and /* in Java Comments
  19. What is an .episode file..?
  20. How do I parse this XML in Java with JAXB?
  21. How to quote “*/” in JavaDocs
  22. How do I set the timeout for a JAX-WS webservice client?
  23. Using JAXB generated class for an element that requires an integer with a pattern
  24. Java 11 package javax.xml.soap does not exist [duplicate]
  25. JAXB filtered parsing
  26. Simple conversion between java.util.Date and XMLGregorianCalendar
  27. Javadoc @author tag good practices
  28. Attaching additional javadoc in Intellij IDEA
  29. Marshalling LocalDate using JAXB
  30. How to marshall a string using JAXB that sometimes contains XML content and sometimes does not?

Leave a Comment