users@jaxb.java.net

Re: Valid javadoc in all jaxb generated sources?

From: Ryan Shoemaker - JavaSoft East <Ryan.Shoemaker_at_Sun.COM>
Date: Wed, 21 Sep 2005 00:50:43 -0400

matthias.geiss_at_sdm.de wrote:
>
> Hello,
> I have a general question on javadoc and jaxb / xjc: I have generated
> classes using xjc. Unfortunately not all classes fulfill the javadoc
> coding standards. In the class ObjectFactory there is for example the
> following generated method:
>
> /**
> * Create an instance of MyObject
> *
> * @throws JAXBException if an error occurs
> */
> public com.test.MyObject createMyObject()
> throws javax.xml.bind.JAXBException
> {
> return new com.test.impl.MyObjectImpl();
> }
>
> to be valid concerning javadoc I would rather expect the following
> (@return Element and Exception qualified in the @throws Element):
>
> /**
> * Create an instance of MyObject
> *
> * @return possible object is
> * {_at_link com.test.MyObject}
> * @throws javax.xml.bind.JAXBException if an error occurs
> */
> public com.test.MyObject createMyObject()
> throws javax.xml.bind.JAXBException
> {
> return new com.test.impl.MyObjectImpl();
> }
>
> Do you have any suggestions for me?

File an issue in IssueTracker[1] and understand that this is a low
priority problem that we will address when we get the chance.

Thanks,

--Ryan

[1] https://jaxb.dev.java.net/servlets/ProjectIssues

> Best regards,
> Matthias
>