add some some comments

11 files changed, 30 insertions, 2 deletions

diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/ANDFilter.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/ANDFilter.java
index 504576f0f4..f9119152e4 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/ANDFilter.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/ANDFilter.java
@@ -18,6 +18,8 @@ import org.eclipse.jpt.common.utility.filter.Filter;
  * If there are wrapped filters, this filter will
  * exhibit "short-circuit" behavior; i.e. if any wrapped filter "rejects"
  * the operand, no following wrapped filters will be evaluated.
+ * 
+ * @param <T> the type of objects to be filtered
  */
 public class ANDFilter<T>
 	extends CompoundFilter<T>
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/CompoundFilter.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/CompoundFilter.java
index 9f36c1aae0..108950cfaa 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/CompoundFilter.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/CompoundFilter.java
@@ -17,6 +17,8 @@ import org.eclipse.jpt.common.utility.internal.StringBuilderTools;
 /**
  * This filter provides a simple framework for combining the behavior
  * of multiple filters.
+ * 
+ * @param <T> the type of objects to be filtered
  */
 public abstract class CompoundFilter<T>
 	implements Filter<T>, Cloneable, Serializable
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/FilterAdapter.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/FilterAdapter.java
index e0fb0d4122..d321eda3cd 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/FilterAdapter.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/FilterAdapter.java
@@ -14,6 +14,8 @@ import org.eclipse.jpt.common.utility.internal.ObjectTools;
 
 /**
  * Convenience filter that "accepts" every object.
+ * 
+ * @param <T> the type of objects to be filtered
  */
 public class FilterAdapter<T>
 	implements Filter<T>
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/NOTFilter.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/NOTFilter.java
index f079d98ead..9d275ba43a 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/NOTFilter.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/NOTFilter.java
@@ -16,6 +16,8 @@ import org.eclipse.jpt.common.utility.internal.ObjectTools;
 /**
  * This filter will "accept" any object that is NOT accepted by
  * the wrapped filter.
+ * 
+ * @param <T> the type of objects to be filtered
  */
 public class NOTFilter<T>
 	implements Filter<T>, Cloneable, Serializable
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/NotNullFilter.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/NotNullFilter.java
index 9b0a749660..b8b48c7910 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/NotNullFilter.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/NotNullFilter.java
@@ -15,6 +15,8 @@ import org.eclipse.jpt.common.utility.filter.Filter;
 
 /**
  * This filter accepts only non-null objects.
+ * 
+ * @param <T> the type of objects to be filtered
  */
 public final class NotNullFilter<T>
 	implements Filter<T>, Serializable
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/ORFilter.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/ORFilter.java
index 8a0e57d228..acf3c73a99 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/ORFilter.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/ORFilter.java
@@ -18,6 +18,8 @@ import org.eclipse.jpt.common.utility.filter.Filter;
  * If there are wrapped filters, this filter will
  * exhibit "short-circuit" behavior; i.e. if any wrapped filter "accepts"
  * the operand, no following wrapped filters will be evaluated.
+ * 
+ * @param <T> the type of objects to be filtered
  */
 public class ORFilter<T>
 	extends CompoundFilter<T>
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/SimpleFilter.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/SimpleFilter.java
index b96293f212..c1dbd8f3fc 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/SimpleFilter.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/SimpleFilter.java
@@ -35,6 +35,9 @@ import org.eclipse.jpt.common.utility.internal.ObjectTools;
  *     }
  * };
  * </pre>
+ * 
+ * @param <T> the type of objects to be filtered
+ * @param <C> the type of the filter's criterion
  */
 public abstract class SimpleFilter<T, C>
 	implements Filter<T>, Cloneable, Serializable
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/XORFilter.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/XORFilter.java
index b13d442839..42dd5fd2d3 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/XORFilter.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/filter/XORFilter.java
@@ -14,6 +14,8 @@ import org.eclipse.jpt.common.utility.filter.Filter;
 /**
  * This compound filter will "accept" any object that is accepted by either of
  * the wrapped filters, but not both. Both filters will always be evaluated.
+ * 
+ * @param <T> the type of objects to be filtered
  */
 public class XORFilter<T>
 	extends CompoundFilter<T>
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/AbstractTransformer.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/AbstractTransformer.java
index aa39e265c9..0174a428af 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/AbstractTransformer.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/AbstractTransformer.java
@@ -13,6 +13,11 @@ package org.eclipse.jpt.common.utility.internal.transformer;
  * Convenience transformer that returns <code>null</code> if the original
  * object is <code>null</code>; otherwise it calls {@link #transform_(Object)},
  * which is to be implemented by subclasses.
+ * 
+ * @param <T1> the type of the object passed to the transformer
+ * @param <T2> the type of the object returned by the transformer
+ * 
+ * @see TransformerAdapter
  */
 public abstract class AbstractTransformer<T1, T2>
 	extends TransformerAdapter<T1, T2>
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/StringObjectTransformer.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/StringObjectTransformer.java
index 8c7eadccbb..5c84286ef5 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/StringObjectTransformer.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/StringObjectTransformer.java
@@ -14,8 +14,9 @@ import org.eclipse.jpt.common.utility.transformer.Transformer;
 
 /**
  * Transform an object into the string returned by its {@link Object#toString()}
- * method. A <code>null</code> object is transformed into a <code>null</code>
- * string.
+ * method. A <code>null</code> object is transformed into <code>null</code>.
+ * 
+ * @param <T> the type of the object passed to the transformer
  */
 public final class StringObjectTransformer<T>
 	extends AbstractTransformer<T, String>
diff --git a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/TransformerAdapter.java b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/TransformerAdapter.java
index 69ef35315b..3c78513721 100644
--- a/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/TransformerAdapter.java
+++ b/common/plugins/org.eclipse.jpt.common.utility/src/org/eclipse/jpt/common/utility/internal/transformer/TransformerAdapter.java
@@ -15,6 +15,11 @@ import org.eclipse.jpt.common.utility.transformer.Transformer;
 /**
  * Convenience transformer that returns <code>null</code> for every
  * transformation.
+ * 
+ * @param <T1> the type of the object passed to the transformer
+ * @param <T2> the type of the object returned by the transformer
+ * 
+ * @see AbstractTransformer
  */
 public class TransformerAdapter<T1, T2>
 	implements Transformer<T1, T2>