Uploaded image for project: 'ServiceMix Components'
  1. ServiceMix Components
  2. SMXCOMP-4

Apply xbean documentation recommendations to the servicemix-mail component

Attach filesAttach ScreenshotVotersWatch issueWatchersCreate sub-taskLinkCloneUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Trivial
    • Resolution: Fixed
    • servicemix-mail-2008.01
    • servicemix-mail-2009.01
    • servicemix-mail
    • None

    Description

      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.

      Attachments

        Activity

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            lhein Lars Heinemann
            adrian.trenaman Adrian Trenaman
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Slack

                Issue deployment