[jira] Assigned: (MAILET-26) Mailet API documentation/contract needs overhaul

["Robert Burrell Donkin (JIRA)" <ma...@james.apache.org>]

     [ https://issues.apache.org/jira/browse/MAILET-26?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Robert Burrell Donkin reassigned MAILET-26:
-------------------------------------------

    Assignee: Robert Burrell Donkin

> Mailet API documentation/contract needs overhaul
> ------------------------------------------------
>
>                 Key: MAILET-26
>                 URL: https://issues.apache.org/jira/browse/MAILET-26
>             Project: Mailet
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 2.4
>            Reporter: Amichai Rothman
>            Assignee: Robert Burrell Donkin
>             Fix For: 2.5
>
>         Attachments: mailet_api_javadocs_3.diff
>
>
> There are lots of issues with the Mailet API documentation, from trivial typos to entire methods whose contract is unclear. Also missing is a clear overview of how the various components interact and how a Mailet container must use them. I went over the entire package's javadocs and fixed them up, occasionally consulting the James implementation to try and decipher what the method contracts were intended to be.
> I'll upload a preliminary patch, and following further discussion and clarifications in the mailing list, I hope we can reach a clear, comprehensive and unambiguous API.

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