[infinispan-issues] [JBoss JIRA] Created: (ISPN-626) Config doc and Javadocs not in sync

[Manik Surtani (JIRA)]

Config doc and Javadocs not in sync
-----------------------------------

                 Key: ISPN-626
                 URL: https://jira.jboss.org/browse/ISPN-626
             Project: Infinispan
          Issue Type: Task
          Components: Configuration
    Affects Versions: 4.1.0.Final
            Reporter: Manik Surtani
            Assignee: Vladimir Blagojevic
            Priority: Minor
             Fix For: 4.2.0.BETA1, 4.2.0.Final


There is an issue with config docs generated not being in sync with the Javadocs on the Configuration and GlobalConfiguration beans.

E.g., the reference in config.html for each XML attribute contains a link to the Javadocs, but this link has 2 problems.

1.  It takes you to the internal AbstractConfigurationBean subclass rather than the setter or getter on Configuration or GlobalConfiguration.

E.g., the locking element has this config doc element: http://docs.jboss.org/infinispan/4.1/apidocs/config.html#ce_default_locking
The Javadoc link to, say, lockAcquisitionTimeout attribute, takes you to http://docs.jboss.org/infinispan/4.1/apidocs/org/infinispan/config/Configuration.LockingType.html#lockAcquisitionTimeout

It should take you to http://docs.jboss.org/infinispan/4.1/apidocs/org/infinispan/config/Configuration.html#setLockAcquisitionTimeout(long) instead, since it is the latter that people actually use programatically.

2.  The setter we link to has no Javadocs!  It should contain the same information on the XML configdoc reference.  We shouldn't repeat ourselves by copying out the same information twice, but instead should perhaps look at providing this information in the src code once and have the configdoc generator pick this up.  



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