Author: rdonkin
Date: Fri Jul 24 19:22:11 2009
New Revision: 797621

URL: http://svn.apache.org/viewvc?rev=797621&view=rev
Log:
JSIEVE-53 Added missing comments https://issues.apache.org/jira/browse/JSIEVE-53

Modified:
    
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/commands/Require.java
    
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/commands/extensions/Log.java
    
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/comparators/ComparatorUtils.java

Modified: 
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/commands/Require.java
URL: 
http://svn.apache.org/viewvc/james/jsieve/trunk/main/src/main/java/org/apache/jsieve/commands/Require.java?rev=797621&r1=797620&r2=797621&view=diff
==============================================================================
--- 
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/commands/Require.java 
(original)
+++ 
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/commands/Require.java 
Fri Jul 24 19:22:11 2009
@@ -71,8 +71,7 @@
      * 
      * @param name
      * @param mail
-     * @param context
-     *            TODO
+     * @param context not nul
      * @throws FeatureException
      */
     protected void validateFeature(String name, MailAdapter mail,
@@ -108,9 +107,8 @@
     /**
      * Method validateTest.
      * 
-     * @param name
-     * @param context
-     *            TODO
+     * @param name not null
+     * @param context not null
      * @throws LookupException
      */
     protected void validateTest(String name, SieveContext context)

Modified: 
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/commands/extensions/Log.java
URL: 
http://svn.apache.org/viewvc/james/jsieve/trunk/main/src/main/java/org/apache/jsieve/commands/extensions/Log.java?rev=797621&r1=797620&r2=797621&view=diff
==============================================================================
--- 
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/commands/extensions/Log.java
 (original)
+++ 
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/commands/extensions/Log.java
 Fri Jul 24 19:22:11 2009
@@ -140,9 +140,8 @@
     /**
      * Method logFatal.
      * 
-     * @param message
-     * @param sieveContext
-     *            TODO
+     * @param message not null
+     * @param sieveContext not null
      */
     protected void logFatal(String message, SieveContext sieveContext) {
         org.apache.commons.logging.Log log = sieveContext.getLog();
@@ -153,9 +152,8 @@
     /**
      * Method logWarn.
      * 
-     * @param message
-     * @param context
-     *            TODO
+     * @param message not null
+     * @param context not null
      */
     protected void logWarn(String message, SieveContext context) {
         org.apache.commons.logging.Log log = context.getLog();
@@ -166,9 +164,8 @@
     /**
      * Method logInfo.
      * 
-     * @param message
-     * @param context
-     *            TODO
+     * @param message not null
+     * @param context not null
      */
     protected void logInfo(String message, SieveContext context) {
         org.apache.commons.logging.Log log = context.getLog();
@@ -179,9 +176,8 @@
     /**
      * Method logDebug.
      * 
-     * @param message
-     * @param context
-     *            TODO
+     * @param message not null
+     * @param context not null
      */
     protected void logDebug(String message, SieveContext context) {
         org.apache.commons.logging.Log log = context.getLog();
@@ -192,9 +188,8 @@
     /**
      * Method logTrace.
      * 
-     * @param message
-     * @param context
-     *            TODO
+     * @param message not null
+     * @param context not null
      */
     protected void logTrace(String message, SieveContext context) {
         org.apache.commons.logging.Log log = context.getLog();
@@ -205,9 +200,8 @@
     /**
      * Method logError.
      * 
-     * @param message
-     * @param context
-     *            TODO
+     * @param message not null
+     * @param context not null
      */
     protected void logError(String message, SieveContext context) {
         org.apache.commons.logging.Log log = context.getLog();

Modified: 
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/comparators/ComparatorUtils.java
URL: 
http://svn.apache.org/viewvc/james/jsieve/trunk/main/src/main/java/org/apache/jsieve/comparators/ComparatorUtils.java?rev=797621&r1=797620&r2=797621&view=diff
==============================================================================
--- 
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/comparators/ComparatorUtils.java
 (original)
+++ 
james/jsieve/trunk/main/src/main/java/org/apache/jsieve/comparators/ComparatorUtils.java
 Fri Jul 24 19:22:11 2009
@@ -46,12 +46,11 @@
      * <code>matchArgument</code> is a match of <code>matchType</code> using
      * the comparator <code>comparatorName</code>.
      * 
-     * @param comparatorName
-     * @param matchType
-     * @param matchTarget
-     * @param matchArgument
-     * @param context
-     *            TODO
+     * @param comparatorName not null
+     * @param matchType not null
+     * @param matchTarget not null
+     * @param matchArgument not null
+     * @param context not null
      * @return boolean
      */
     public static boolean match(String comparatorName, String matchType,
@@ -184,10 +183,10 @@
      * Method <code>contains<code> answers a boolean indicating if the 
parameter 
      * <code>container</code> contains the parameter <code>contents</code> 
using an
      * instance of <code>comparatorName</code>.
-     * @param comparatorName
-     * @param container
-     * @param contents
-     * @param context TODO
+     * @param comparatorName not null
+     * @param container not null
+     * @param contents not null
+     * @param context not null
      * @return boolean
      */
     public static boolean contains(String comparatorName, String container,
@@ -201,9 +200,9 @@
      * <code>container</code> is equal to the parameter <code>contents</code> 
using 
      * an instance of <code>comparatorName</code>.
      * @param comparatorName
-     * @param string1
-     * @param string2
-     * @param context TODO
+     * @param string1 not null
+     * @param string2 not null
+     * @param context not null
      * @return boolean
      */
     public static boolean is(String comparatorName, String string1,
@@ -217,10 +216,10 @@
      * parameter
      * <code>string/code> is matched by the patterm <code>glob</code> using an
      * instance of <code>comparatorName</code>.
-     * @param comparatorName
-     * @param string
-     * @param glob
-     * @param context TODO
+     * @param comparatorName not null
+     * @param string not null
+     * @param glob not null
+     * @param context not null
      * @return boolean
      */
     public static boolean matches(String comparatorName, String string,



---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to