Author: rdonkin
Date: Thu Apr 24 23:21:57 2008
New Revision: 651498

URL: http://svn.apache.org/viewvc?rev=651498&view=rev
Log:
Improved javadocs.

Modified:
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/mailets/AddHabeasWarrantMark.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/All.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HasHabeasWarrantMark.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HostIs.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HostIsLocal.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/IsSingleRecipient.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RecipientIs.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RecipientIsLocal.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RelayLimit.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SenderIs.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SubjectIs.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SubjectStartsWith.java
    
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/UserIs.java
    james/mailet/standard/trunk/src/site/xdoc/index.xml

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/mailets/AddHabeasWarrantMark.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/mailets/AddHabeasWarrantMark.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/mailets/AddHabeasWarrantMark.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/mailets/AddHabeasWarrantMark.java
 Thu Apr 24 23:21:57 2008
@@ -25,7 +25,7 @@
 import org.apache.mailet.GenericMailet ;
 import org.apache.mailet.Mail ;
 
-/*
+/**
  * This matcher adds the Hebeas Warrant Mark to a message.
  * For details see: http://www.hebeas.com
  *

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/All.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/All.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/All.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/All.java
 Thu Apr 24 23:21:57 2008
@@ -24,6 +24,7 @@
 import java.util.Collection;
 
 /**
+ * Matches all mail.
  * @version 1.0.0, 24/04/1999
  */
 public class All extends GenericMatcher {

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HasHabeasWarrantMark.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HasHabeasWarrantMark.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HasHabeasWarrantMark.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HasHabeasWarrantMark.java
 Thu Apr 24 23:21:57 2008
@@ -28,7 +28,7 @@
 import javax.mail.internet.MimeMessage;
 import java.util.Collection;
 
-/*
+/**
  * This matcher tests for the Hebeas Warrant Mark.
  * For details see: http://www.hebeas.com
  *

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HostIs.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HostIs.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HostIs.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HostIs.java
 Thu Apr 24 23:21:57 2008
@@ -30,6 +30,7 @@
 import java.util.Vector;
 
 /**
+ * Matches mail from given hosts.
  * @version 1.0.0, 24/04/1999
  */
 public class HostIs extends GenericRecipientMatcher {

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HostIsLocal.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HostIsLocal.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HostIsLocal.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/HostIsLocal.java
 Thu Apr 24 23:21:57 2008
@@ -25,6 +25,7 @@
 import org.apache.mailet.MailAddress;
 
 /**
+ * Matches mail from localhost.
  * @version 1.0.0, 24/04/1999
  */
 public class HostIsLocal extends GenericRecipientMatcher {

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/IsSingleRecipient.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/IsSingleRecipient.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/IsSingleRecipient.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/IsSingleRecipient.java
 Thu Apr 24 23:21:57 2008
@@ -27,6 +27,7 @@
 import java.util.Collection;
 
 /**
+ * Matches mail where the number of recipiants is exactly one.
  * @version 1.0.0, 04/12/2000
  */
 public class IsSingleRecipient extends GenericMatcher {

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RecipientIs.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RecipientIs.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RecipientIs.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RecipientIs.java
 Thu Apr 24 23:21:57 2008
@@ -28,6 +28,7 @@
 import java.util.StringTokenizer;
 
 /**
+ * Matches mail where the recipent is one of a configurable list.
  * @version 1.0.0, 24/04/1999
  */
 public class RecipientIs extends GenericRecipientMatcher {

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RecipientIsLocal.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RecipientIsLocal.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RecipientIsLocal.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RecipientIsLocal.java
 Thu Apr 24 23:21:57 2008
@@ -26,6 +26,7 @@
 import org.apache.mailet.MailetContext;
 
 /**
+ * Matches mail where the recipient is local.
  * @version 1.0.0, 24/04/1999
  */
 public class RecipientIsLocal extends GenericRecipientMatcher {

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RelayLimit.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RelayLimit.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RelayLimit.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/RelayLimit.java
 Thu Apr 24 23:21:57 2008
@@ -32,7 +32,7 @@
 import java.util.Enumeration;
 
 /**
- *
+ * Matches mail which has been relayed more than a given number of times.
  * @version 1.0.0, 1/5/2000
  */
 

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SenderIs.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SenderIs.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SenderIs.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SenderIs.java
 Thu Apr 24 23:21:57 2008
@@ -29,6 +29,7 @@
 import java.util.StringTokenizer;
 
 /**
+ * Matches mail where the sender is contained in a configurable list.
  * @version 1.0.0, 24/04/1999
  */
 public class SenderIs extends GenericMatcher {

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SubjectIs.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SubjectIs.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SubjectIs.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SubjectIs.java
 Thu Apr 24 23:21:57 2008
@@ -28,10 +28,9 @@
 import java.util.Collection;
 
 /**
- *
+ * Matches mail where the subject is contained in a configurable list.
  * @version 1.0.0, 1/5/2000
  */
-
 public class SubjectIs extends GenericMatcher {
     public Collection match(Mail mail) throws javax.mail.MessagingException {
         MimeMessage mm = mail.getMessage();

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SubjectStartsWith.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SubjectStartsWith.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SubjectStartsWith.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/SubjectStartsWith.java
 Thu Apr 24 23:21:57 2008
@@ -29,10 +29,9 @@
 import java.util.Collection;
 
 /**
- *
+ * Matches mail where the subject starts with a given phrase.
  * @version 1.0.0, 1/5/2000
  */
-
 public class SubjectStartsWith extends GenericMatcher {
 
     public Collection match(Mail mail) throws MessagingException {

Modified: 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/UserIs.java
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/UserIs.java?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/UserIs.java
 (original)
+++ 
james/mailet/standard/trunk/src/main/java/org/apache/james/transport/matchers/UserIs.java
 Thu Apr 24 23:21:57 2008
@@ -28,6 +28,7 @@
 import java.util.Vector;
 
 /**
+ * Matches mail where the user is contained in a configurable list.
  * @version 1.0.0, 24/04/1999
  */
 public class UserIs extends GenericRecipientMatcher {

Modified: james/mailet/standard/trunk/src/site/xdoc/index.xml
URL: 
http://svn.apache.org/viewvc/james/mailet/standard/trunk/src/site/xdoc/index.xml?rev=651498&r1=651497&r2=651498&view=diff
==============================================================================
--- james/mailet/standard/trunk/src/site/xdoc/index.xml (original)
+++ james/mailet/standard/trunk/src/site/xdoc/index.xml Thu Apr 24 23:21:57 2008
@@ -24,7 +24,10 @@
   </properties>
   <body>
     <section name="Standard Mailets">
-       <p>A collection of generally useful reusable mailets with minimal 
depedencies.</p>
+       <p>A collection of generally useful reusable mailets and matchers with 
minimal depedencies.</p>
+    </section>
+    <section name='Catalog'>
+        <p>For more information see the <a 
href='apidocs/index.html'>javadocs</a>.</p>
     </section>
   </body>
 </document>



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to