[infinispan-issues] [JBoss JIRA] Commented: (ISPN-89) Document all configuration options available in XML and the Configuration beans on the wiki

[Manik Surtani (JIRA)]

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

Manik Surtani commented on ISPN-89:
-----------------------------------

A good way to do this is to use a doclet.  I have created a module in Infiinspan trunk for tools such as this, and I have created a custom Doclet to generate documentation on JMX information exposed.  

Perhaps a similar approach could be used for configuration.  Maybe what could be done is to use a custom javadoc tag on all ConfigurationComponent setters, to include an XPath style notation to the equivalent XML attribute (e.g., /infinispan/namedCache/cluster/async[@useReplicationQueue]) as well as default value and allowed value tags.  

The Doclet could generate errors if any of these are missing for any setter.

And based on this, an HTML document could be generated.  See:

http://anonsvn.jboss.org/repos/infinispan/trunk/tools/src/main/java/org/infinispan/tools/doclet/jmx/JmxDoclet.java

and the resulting html file:

http://infinispan.sourceforge.net/4.0/apidocs/jmxComponents.html



> Document all configuration options available in XML and the Configuration beans on the wiki
> -------------------------------------------------------------------------------------------
>
>                 Key: ISPN-89
>                 URL: https://jira.jboss.org/jira/browse/ISPN-89
>             Project: Infinispan
>          Issue Type: Task
>          Components: Configuration
>            Reporter: Manik Surtani
>            Assignee: Galder Zamarreño
>             Fix For: 4.0.0.GA
>
>
> This used to be in the User Guide of JBC, and now since we don't have a User Guide and everything is maintained on the wiki, we need a table on the wiki.  Perhaps something that looks like this:
> http://www.jboss.org/file-access/default/members/jbosscache/freezone/docs/3.0.3.GA/userguide_en/html/configuration_reference_chapter.html#configuration_reference
> Should explain each XML element, attribute, allowed values, default values, and equivalent setter in the Configuration bean.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira