Mailet overview not complete

• Key: JAMES-327
• Type: Bug
• Status: Closed
• Resolution: Fixed
• Priority: Major
• Assignee: Norman Maurer
• Reporter: Hes Siemelink
• Component/s: Documentation
• Affects Version/s: 2.3.0
• Fix Version/s: 2.3.0

Description

The overview of mailets is not complete. For example, the FromRepository mailet is missing.

See http://james.apache.org/provided_mailets_2_1.html and compare with the mailets in the package org.apache.james.transport.mailets

Thanks,

   Hes.

Comments

[Hes Siemelink]

It turns out that the documentation has been updated in the CVS branch branch_2_1_fcs.

However, the site is generated from the MAIN branch using outdated files.

Proposed fix: copy the contents of src/xdocs from branch_2_1_fcs to MAIN and regenerate the web site.

[Noel J. Bergman]

Do NOT copy over the xdocs. They are only partially updated, specifically for the version 2 release. The public site is generated from MAIN, and only that has been maintained.

[Hes Siemelink]

At least the file src/xdocs/provided_mailets_2_1.xml from the branch_2_1_fcs should be published on the web site.

[Hes Siemelink]

Here's the diff that will update provided_mailets_2_1.xml in trunk, so it can be published to the web site.

[Vincenzo Gianferrari Pini]

The documentation in branch_2_1_fcs/src/xdocs/provided_mailets_2_1.xml is *not* up-to-date (many more mailets and matchers are missing), so first of all it has to be updated before updating the version in trunk.

[Hes Siemelink]

A while back I proposed to use xdoclet for mailet/matcher documentation.

See http://nagoya.apache.org/eyebrowse/ReadMsg?listName=[e-mail]&msgId=2072253

I could spend some time on converting the documentation, provided that a committer commits to committing the changes into SVN.

[Norman Maurer]

This should fixed before release 2.3.0

[Norman Maurer]

- Fixed in trunk
- Backported in branch
- Updated site

[Danny Angus]

Closing issue fixed in released version.