[
https://issues.apache.org/activemq/browse/SM-1642?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Adrian Trenaman updated SM-1642:
--------------------------------
Attachment: servicemix-common-comment-tidyup.patch
servicemix-file-comment-tidyup.patch
> 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-file-2008.01
> Environment: All
> Reporter: Adrian Trenaman
> Priority: Minor
> Fix For: servicemix-file-2008.02
>
> Attachments: servicemix-common-comment-tidyup.patch,
> servicemix-file-comment-tidyup.patch, servicemix-file.patch
>
> Original Estimate: 0 minutes
> Remaining Estimate: 0 minutes
>
> 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.
