[infinispan-issues] [JBoss JIRA] (ISPN-1632) Add XML documentation generation from XSD

[Manik Surtani (Commented) (JIRA)]

    [ https://issues.jboss.org/browse/ISPN-1632?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12654502#comment-12654502 ] 

Manik Surtani commented on ISPN-1632:
-------------------------------------

Hmm, I've added what is generated and this is what I see: http://dl.dropbox.com/u/6524335/infinispan-5.1.-xsd.html

I'm not sure how useful this is, since all this does is describe the various XSD elements but doesn't really add much information on what each of these elements mean.  Look at what we did for the config docs prior to 5.1:  https://docs.jboss.org/infinispan/5.0/apidocs/config.html 

Each element is properly documented (from the Javadocs on the corresponding getters/setters in the programmatic API) and linked to the corresponding Javadocs as well.  Now I realise not all of this will apply but there must be something we can do to make this somewhat more user-friendly?
                
> Add XML documentation generation from XSD
> -----------------------------------------
>
>                 Key: ISPN-1632
>                 URL: https://issues.jboss.org/browse/ISPN-1632
>             Project: Infinispan
>          Issue Type: Feature Request
>          Components: Configuration
>    Affects Versions: 5.1.0.CR1
>            Reporter: Pete Muir
>            Assignee: Manik Surtani
>             Fix For: 5.1.0.CR3, 5.1.0.FINAL
>
>


--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira