[SMXCOMP-179] Add better documentation around attributes & elements for the servicemix-file component

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: servicemix-file-2008.01
• Fix Version/s: servicemix-file-2009.01, servicemix-shared-2009.01

Environment

All

• Patch Info: Patch Available
• Assignee: Freeman Yue Fang
• Reporter: Adrian Trenaman
• Created: 22/Oct/08 10:56
• Updated: 14/Feb/09 22:07
• Resolved: 14/Nov/08 03:02

Description

Currently documentation annotations in the xbean schema for the servicemix-file component aren't very helpful, or, in some cases, are non-existant. This limits the effectiveness of using the built-in support for XML editing in tools like Eclipse.

I've updated the the FilePoller and FileSender endpoint so that documentation for the attributes is derived from the javadoc information on the set* method. Previously this was a bit of a mess, with documentation duplicated on the get*(), set*() methods and in @org.apache.xbean.Property description annotations.

Additionally, I've added a number of "wrapper" methods to provide documentation for attributes inherited from base classes: at compile time the xbean plugin has access to the base classes but not the source code, so we don't get any documentation generated. The wrappers get around this; it's not the perfect solution, but it does generate nice self-documenting XSD.

Patch attached.