Add better documentation around attributes & elements for the servicemix-file
component
---------------------------------------------------------------------------------------
Key: SM-1642
URL: https://issues.apache.org/activemq/browse/SM-1642
Project: ServiceMix
Issue Type: Improvement
Affects Versions: servicemix-validation-2008.01
Environment: All
Reporter: Adrian Trenaman
Attachments: servicemix-file.patch
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.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
