Javadoc that includes schema documentation

[J B <mo...@gmail.com>]

I know there is an existing Jira ticket for this,. but I was wondering
what the status is.  I have been experimenting and have support for
producing javadoc for complex types at the class level, but there
seems to be no easy way to get he documentation out of the elements
within the complex type.  This is due to the use of properties.  It
looks like if it was built using the particle system instead, we would
have access to what we need.  I do see at least one approach that
might work without going this route, but before I dug in, I wanted to
see if any one else has done this yet.  We have a strong need to
include these schema documentation annotations in the generated java
source file for javadoc purposes.

Thanks for any feedback.

Birch

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@xmlbeans.apache.org
For additional commands, e-mail: user-help@xmlbeans.apache.org

RE: Javadoc that includes schema documentation

[Radu Preotiuc-Pietro <ra...@bea.com>]

Agreed that there is no easy way. The problem is that you can have two
different local element declarations with the same name but different
documentation tags. In Java, those are represented by the same
SchemaProperty. So you have to either merge all of them into one JavaDoc
or get the first one and ignore the others. That's where the difficulty
comes from.

You could say that indeed the Java code is produced from the particle
system by using the schema properties as intermediaries. So one would
need to change SchemaProperty and make it aware of documentation
sections.

Definitely it would be great if you could do this and contribute it to
the project!

Thanks,
Radu

> -----Original Message-----
> From: J B [mailto:moatas@gmail.com] 
> Sent: Thursday, June 05, 2008 5:20 PM
> To: user@xmlbeans.apache.org
> Subject: Javadoc that includes schema documentation
> 
> I know there is an existing Jira ticket for this,. but I was 
> wondering what the status is.  I have been experimenting and 
> have support for producing javadoc for complex types at the 
> class level, but there seems to be no easy way to get he 
> documentation out of the elements within the complex type.  
> This is due to the use of properties.  It looks like if it 
> was built using the particle system instead, we would have 
> access to what we need.  I do see at least one approach that 
> might work without going this route, but before I dug in, I 
> wanted to see if any one else has done this yet.  We have a 
> strong need to include these schema documentation annotations 
> in the generated java source file for javadoc purposes.
> 
> Thanks for any feedback.
> 
> Birch
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: user-unsubscribe@xmlbeans.apache.org
> For additional commands, e-mail: user-help@xmlbeans.apache.org
> 
> 

Notice:  This email message, together with any attachments, may contain information  of  BEA Systems,  Inc.,  its subsidiaries  and  affiliated entities,  that may be confidential,  proprietary,  copyrighted  and/or legally privileged, and is intended solely for the use of the individual or entity named in this message. If you are not the intended recipient, and have received this message in error, please immediately return this by email and then delete it.

---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@xmlbeans.apache.org
For additional commands, e-mail: user-help@xmlbeans.apache.org