You are viewing a plain text version of this content. The canonical link for it is here.
Posted to mailet-api@james.apache.org by "Amichai Rothman (JIRA)" <ma...@james.apache.org> on 2009/08/02 10:40:14 UTC
[jira] Created: (MAILET-26) Mailet API documentation/contract needs
overhaul
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
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.
[jira] Closed: (MAILET-26) Mailet API documentation/contract needs
overhaul
Posted by "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 closed MAILET-26.
---------------------------------------
Resolution: Fixed
Committed (with a few changes)
Many thanks
Robert
> 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.
[jira] Assigned: (MAILET-26) Mailet API documentation/contract
needs overhaul
Posted by "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.
[jira] Updated: (MAILET-26) Mailet API documentation/contract needs
overhaul
Posted by "Amichai Rothman (JIRA)" <ma...@james.apache.org>.
[ https://issues.apache.org/jira/browse/MAILET-26?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Amichai Rothman updated MAILET-26:
----------------------------------
Attachment: mailet_api_javadocs_3.diff
Fixed up and rewrritten docs
> 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
> 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.
[jira] Updated: (MAILET-26) Mailet API documentation/contract needs
overhaul
Posted by "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 updated MAILET-26:
----------------------------------------
Fix Version/s: 2.5
> 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
> 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.