[jbossts-issues] [JBoss JIRA] (JBTM-1116) Document properties

Tue Dec 4 05:20:21 EST 2012

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

Jonathan Halliday commented on JBTM-1116:
-----------------------------------------

We dropped the docs on purpose, as they kept getting out of sync and being misleading. In the case of the properties file, putting in all properties, their docs and defaults made it harder to find the small number of important properties that do need setting (e.g. node id) and gave the user way too many opportunities to break things.  The only properties reference is now the javadoc on the bean classes.  We did mull over generating or linking the docs to/from the javadoc, but never got around to the necessary tooling.

> Document properties
> -------------------
>
>                 Key: JBTM-1116
>                 URL: https://issues.jboss.org/browse/JBTM-1116
>             Project: JBoss Transaction Manager
>          Issue Type: Feature Request
>      Security Level: Public(Everyone can see) 
>          Components: Documentation
>            Reporter: Tom Jenkinson
>            Assignee: Gytis Trikleris
>             Fix For: 5.0.0.M3
>
>
> In the pre-Bean days of setting properties, we had all of the TS properties called out in a properties.xml file. In that file there were copious comments to say what the property was for and whether it should be changed. We also documented these properties in the docs. It seems from some investigation that Mike and I have done today that the migration away from the properties file to using MBeans has removed those comments and the docs for the properties. Sometimes the comments do appear in the code.
> If you go back to before everything got turned everything into a Bean (probably 4.6.1 GA) then look in the etc directories.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira