You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@servicemix.apache.org by "Adrian Trenaman (JIRA)" <ji...@apache.org> on 2008/10/22 12:56:52 UTC
[jira] Created: (SM-1642) Add better documentation around
attributes & elements for the servicemix-file component
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.
[jira] Resolved: (SM-1642) Add better documentation around
attributes & elements for the servicemix-file component
Posted by "Freeman Fang (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/activemq/browse/SM-1642?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Freeman Fang resolved SM-1642.
------------------------------
Fix Version/s: servicemix-shared-2008.02
3.3.1
Resolution: Fixed
apply patch on behalf of Adrian Trenaman with thanks
http://svn.apache.org/viewvc?rev=713911&view=rev for servicemix-file component project
http://svn.apache.org/viewvc?rev=713912&view=rev for servicemix-shared component project
> 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
> Assignee: Freeman Fang
> Priority: Minor
> Fix For: servicemix-shared-2008.02, servicemix-file-2008.02, 3.3.1
>
> Attachments: servicemix-common-comment-tidyup.patch, servicemix-file-comment-tidyup.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.
[jira] Updated: (SM-1642) Add better documentation around
attributes & elements for the servicemix-file component
Posted by "Adrian Trenaman (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/activemq/browse/SM-1642?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Adrian Trenaman updated SM-1642:
--------------------------------
Attachment: (was: servicemix-file.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
>
> 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.
[jira] Updated: (SM-1642) Add better documentation around
attributes & elements for the servicemix-file component
Posted by "Guillaume Nodet (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/activemq/browse/SM-1642?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Guillaume Nodet updated SM-1642:
--------------------------------
Fix Version/s: servicemix-file-2008.02
Affects Version/s: servicemix-file-2008.01
(was: servicemix-validation-2008.01)
> 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-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.
[jira] Assigned: (SM-1642) Add better documentation around
attributes & elements for the servicemix-file component
Posted by "Freeman Fang (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/activemq/browse/SM-1642?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Freeman Fang reassigned SM-1642:
--------------------------------
Assignee: Freeman Fang
> 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
> Assignee: Freeman Fang
> Priority: Minor
> Fix For: servicemix-file-2008.02
>
> Attachments: servicemix-common-comment-tidyup.patch, servicemix-file-comment-tidyup.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.
[jira] Commented: (SM-1642) Add better documentation around
attributes & elements for the servicemix-file component
Posted by "Adrian Trenaman (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/activemq/browse/SM-1642?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=46677#action_46677 ]
Adrian Trenaman commented on SM-1642:
-------------------------------------
I've updated this issue and added two updated patches servicemix-common-comment-tidyup.patch and servicemix-file-comment-tidyup.patch. These updates use a POM source-level dependency to ensure that you don't have to override methods to get base- properties documented.
> 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
>
> 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.
[jira] Work started: (SM-1642) Add better documentation around
attributes & elements for the servicemix-file component
Posted by "Freeman Fang (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/activemq/browse/SM-1642?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Work on SM-1642 started by Freeman Fang.
> 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
> Assignee: Freeman Fang
> Priority: Minor
> Fix For: servicemix-file-2008.02
>
> Attachments: servicemix-common-comment-tidyup.patch, servicemix-file-comment-tidyup.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.
[jira] Updated: (SM-1642) Add better documentation around
attributes & elements for the servicemix-file component
Posted by "Adrian Trenaman (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/activemq/browse/SM-1642?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Adrian Trenaman updated SM-1642:
--------------------------------
Priority: Minor (was: Major)
> 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
> Priority: Minor
> Attachments: 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.
[jira] Updated: (SM-1642) Add better documentation around
attributes & elements for the servicemix-file component
Posted by "Adrian Trenaman (JIRA)" <ji...@apache.org>.
[ 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.