I'm currently working with an XML Schema that has
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
Add a child to
<xsd: element> or
<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: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.