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/23 13:24:52 UTC

[jira] Created: (SM-1652) Apply xbean documentation recommendations to the servicemix-mail component

Apply xbean documentation recommendations to the servicemix-mail component
--------------------------------------------------------------------------

                 Key: SM-1652
                 URL: https://issues.apache.org/activemq/browse/SM-1652
             Project: ServiceMix
          Issue Type: Improvement
          Components: servicemix-mail
    Affects Versions: servicemix-mail-2008.01
            Reporter: Adrian Trenaman
            Priority: Trivial


Apply the recommendations outlined in http://cwiki.apache.org/confluence/display/SMX4/Annotating+servicemix+endpoints+for+auto-generated+documentation to the servicemix-mail component to facilitate auto generation of quality comments for XSD, Wiki, HTML & JavaDoc. 

Right now the properties are only very loosely documented: we should document each one explicitly, including stating the default value (if one applies), aiming the documentation at developers who can use the docu for context sensitive help in Eclipse.

Also, would be good to include descriptions of the connection Uris, as per the documentation at http://servicemix.apache.org/servicemix-mail.html.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Resolved: (SM-1652) Apply xbean documentation recommendations to the servicemix-mail component

Posted by "Lars Heinemann (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/activemq/browse/SM-1652?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Lars Heinemann resolved SM-1652.
--------------------------------

       Resolution: Fixed
    Fix Version/s: servicemix-mail-2008.02

fixed in Rev. 723907

> Apply xbean documentation recommendations to the servicemix-mail component
> --------------------------------------------------------------------------
>
>                 Key: SM-1652
>                 URL: https://issues.apache.org/activemq/browse/SM-1652
>             Project: ServiceMix
>          Issue Type: Improvement
>          Components: servicemix-mail
>    Affects Versions: servicemix-mail-2008.01
>            Reporter: Adrian Trenaman
>            Assignee: Lars Heinemann
>            Priority: Trivial
>             Fix For: servicemix-mail-2008.02
>
>
> Apply the recommendations outlined in http://cwiki.apache.org/confluence/display/SMX4/Annotating+servicemix+endpoints+for+auto-generated+documentation to the servicemix-mail component to facilitate auto generation of quality comments for XSD, Wiki, HTML & JavaDoc. 
> Right now the properties are only very loosely documented: we should document each one explicitly, including stating the default value (if one applies), aiming the documentation at developers who can use the docu for context sensitive help in Eclipse.
> Also, would be good to include descriptions of the connection Uris, as per the documentation at http://servicemix.apache.org/servicemix-mail.html.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Assigned: (SM-1652) Apply xbean documentation recommendations to the servicemix-mail component

Posted by "Lars Heinemann (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/activemq/browse/SM-1652?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Lars Heinemann reassigned SM-1652:
----------------------------------

    Assignee: Lars Heinemann

> Apply xbean documentation recommendations to the servicemix-mail component
> --------------------------------------------------------------------------
>
>                 Key: SM-1652
>                 URL: https://issues.apache.org/activemq/browse/SM-1652
>             Project: ServiceMix
>          Issue Type: Improvement
>          Components: servicemix-mail
>    Affects Versions: servicemix-mail-2008.01
>            Reporter: Adrian Trenaman
>            Assignee: Lars Heinemann
>            Priority: Trivial
>
> Apply the recommendations outlined in http://cwiki.apache.org/confluence/display/SMX4/Annotating+servicemix+endpoints+for+auto-generated+documentation to the servicemix-mail component to facilitate auto generation of quality comments for XSD, Wiki, HTML & JavaDoc. 
> Right now the properties are only very loosely documented: we should document each one explicitly, including stating the default value (if one applies), aiming the documentation at developers who can use the docu for context sensitive help in Eclipse.
> Also, would be good to include descriptions of the connection Uris, as per the documentation at http://servicemix.apache.org/servicemix-mail.html.

-- 
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-1652) Apply xbean documentation recommendations to the servicemix-mail component

Posted by "Lars Heinemann (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/activemq/browse/SM-1652?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Work on SM-1652 started by Lars Heinemann.

> Apply xbean documentation recommendations to the servicemix-mail component
> --------------------------------------------------------------------------
>
>                 Key: SM-1652
>                 URL: https://issues.apache.org/activemq/browse/SM-1652
>             Project: ServiceMix
>          Issue Type: Improvement
>          Components: servicemix-mail
>    Affects Versions: servicemix-mail-2008.01
>            Reporter: Adrian Trenaman
>            Assignee: Lars Heinemann
>            Priority: Trivial
>
> Apply the recommendations outlined in http://cwiki.apache.org/confluence/display/SMX4/Annotating+servicemix+endpoints+for+auto-generated+documentation to the servicemix-mail component to facilitate auto generation of quality comments for XSD, Wiki, HTML & JavaDoc. 
> Right now the properties are only very loosely documented: we should document each one explicitly, including stating the default value (if one applies), aiming the documentation at developers who can use the docu for context sensitive help in Eclipse.
> Also, would be good to include descriptions of the connection Uris, as per the documentation at http://servicemix.apache.org/servicemix-mail.html.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.