Cleanedup JavaDoc Issues

Removed legacy SVN id's.

Author: khmarbaise

src/main/java/org/codehaus/plexus/interpolation/AbstractFunctionValueSourceWrapper.java

@@ -24,11 +24,9 @@
  * {@link AbstractFunctionValueSourceWrapper#executeFunction(String, Object)}
  * together. The result of this is returned as the resolved value for the second
  * expression.
- * <br/>
- * This allows the first expression to be a function name that modifies the
+ * <p>This allows the first expression to be a function name that modifies the
  * value of the second expression, which is resolved from the wrapped value
- * source.
- * @version $Id$
+ * source.</p>
  */
 public abstract class AbstractFunctionValueSourceWrapper
     implements ValueSource
@@ -74,6 +72,7 @@ public Object getValue( String expression )
 
     /**
      * Retrieve the embedded value source.
+     * @return {@link ValueSource}
      */
     protected ValueSource getValueSource()
     {

src/main/java/org/codehaus/plexus/interpolation/BasicInterpolator.java

@@ -24,29 +24,33 @@ public interface BasicInterpolator
 {
     /**
      * See {@link org.codehaus.plexus.interpolation.Interpolator#interpolate(String, String, org.codehaus.plexus.interpolation.RecursionInterceptor)}.
-     * <br/>
+     * <p>
      * This method triggers the use of a {@link org.codehaus.plexus.interpolation.SimpleRecursionInterceptor}
      * instance for protection against expression cycles. It also leaves empty the
      * expression prefix which would otherwise be trimmed from expressions. The
-     * result is that any detected expression will be resolved as-is.
+     * result is that any detected expression will be resolved as-is.</p>
      *
      * @param input The input string to interpolate
+     * @return the interpolated string.
+     * @throws InterpolationException in case of an error.
      */
     String interpolate( String input )
         throws InterpolationException;
 
     /**
      * See {@link org.codehaus.plexus.interpolation.Interpolator#interpolate(String, String, org.codehaus.plexus.interpolation.RecursionInterceptor)}.
-     * <br/>
+     * <p>
      * This method leaves empty the expression prefix which would otherwise be
      * trimmed from expressions. The result is that any detected expression will
-     * be resolved as-is.
+     * be resolved as-is.</p>
      *
      * @param input The input string to interpolate
      *
      * @param recursionInterceptor Used to protect the interpolation process
      *                             from expression cycles, and throw an
      *                             exception if one is detected.
+     * @return the interpolated string.
+     * @throws InterpolationException in case of an error.
      */
     String interpolate( String input, RecursionInterceptor recursionInterceptor )
         throws InterpolationException;

src/main/java/org/codehaus/plexus/interpolation/EnvarBasedValueSource.java

@@ -26,8 +26,6 @@
  * available from the underlying operating system (and possibly, the shell environment
  * that created the present Java process). If the expression starts with 'env.',
  * this prefix is trimmed before resolving the rest as an environment variable name.
- *
- * @version $Id$
  */
 public class EnvarBasedValueSource
     extends AbstractValueSource
@@ -43,7 +41,7 @@ public class EnvarBasedValueSource
      * Create a new value source for interpolation based on shell environment variables. In this
      * case, envar keys ARE CASE SENSITIVE.
      *
-     * @throws IOException
+     * @throws IOException in case of an error.
      */
     public EnvarBasedValueSource() throws IOException
     {
@@ -55,7 +53,7 @@ public EnvarBasedValueSource() throws IOException
      *
      * @param caseSensitive Whether the environment variable key should be treated in a
      *                      case-sensitive manner for lookups
-     * @throws IOException
+     * @throws IOException in case of an error.
      */
     public EnvarBasedValueSource( boolean caseSensitive ) throws IOException
     {

src/main/java/org/codehaus/plexus/interpolation/FeedbackEnabledValueSource.java

@@ -22,7 +22,6 @@
  * about what may have gone wrong while resolving the value for an expression.
  *
  * @author jdcasey
- * @version $Id$
  *
  * @deprecated Rolled into {@link ValueSource} now.
  */

src/main/java/org/codehaus/plexus/interpolation/InterpolationException.java

@@ -25,7 +25,6 @@
  * being thrown. Instead, they should be reported in the feedback from the {@link ValueSource},
  * which is propagated out through {@link Interpolator#getFeedback()}.
  * 
- * @version $Id$
  */
 public class InterpolationException
     extends Exception

src/main/java/org/codehaus/plexus/interpolation/InterpolationPostProcessor.java

@@ -19,7 +19,6 @@
 /**
  * Used to allow full recursion of value interpolation before applying some rule
  * to the result.
- * @version $Id$
  */
 public interface InterpolationPostProcessor
 {

src/main/java/org/codehaus/plexus/interpolation/Interpolator.java

@@ -22,7 +22,6 @@
  * Interpolator interface. Based on existing RegexBasedInterpolator interface.
  *
  * @author cstamas
- * @version $Id$
  */
 public interface Interpolator
     extends BasicInterpolator
@@ -31,36 +30,42 @@ public interface Interpolator
     /**
      * Add a new {@link ValueSource} to the stack used to resolve expressions
      * in this interpolator instance.
+     * @param valueSource {@link ValueSource}.
      */
     void addValueSource( ValueSource valueSource );
 
     /**
      * Remove the specified {@link ValueSource} from the stack used to resolve
      * expressions in this interpolator instance.
+     * @param valueSource {@link ValueSource}.
      */
     void removeValuesSource( ValueSource valueSource );
 
     /**
      * Add a new post-processor to handle final processing after 
      * recursively-interpolated value is determined.
+     * @param postProcessor {@link InterpolationPostProcessor}.
      */
     void addPostProcessor( InterpolationPostProcessor postProcessor );
 
     /**
      * Remove the given post-processor.
+     * @param postProcessor {@link InterpolationPostProcessor}.
      */
     void removePostProcessor( InterpolationPostProcessor postProcessor );
 
     /**
      * See {@link Interpolator#interpolate(String, String, RecursionInterceptor)}.
-     * <br/>
+     * <p>
      * This method triggers the use of a {@link SimpleRecursionInterceptor}
-     * instance for protection against expression cycles.
+     * instance for protection against expression cycles.</p>
      *
      * @param input The input string to interpolate
      *
      * @param thisPrefixPattern An optional pattern that should be trimmed from
      *                          the start of any expressions found in the input.
+     * @return interpolated string.
+     * @throws InterpolationException in case of an error.
      */
     String interpolate( String input,
                         String thisPrefixPattern )
@@ -81,6 +86,8 @@ String interpolate( String input,
      * @param recursionInterceptor Used to protect the interpolation process
      *                             from expression cycles, and throw an
      *                             exception if one is detected.
+     * @return interpolated string.
+     * @throws InterpolationException in case of an error.
      */
     String interpolate( String input,
                         String thisPrefixPattern,
@@ -103,8 +110,14 @@ String interpolate( String input,
      */
     void clearFeedback();
 
+    /**
+     * @return state of the cacheAnswers
+     */
     boolean isCacheAnswers();
 
+    /**
+     * @param cacheAnswers true/false.
+     */
     void setCacheAnswers( boolean cacheAnswers );
 
     void clearAnswers();

src/main/java/org/codehaus/plexus/interpolation/InterpolatorFilterReader.java

@@ -63,7 +63,6 @@
  * implementation. This implementation is heavily based on org.codehaus.plexus.util.InterpolationFilterReader.
  *
  * @author cstamas
- * @version $Id$
  */
 public class InterpolatorFilterReader
     extends FilterReader

src/main/java/org/codehaus/plexus/interpolation/MapBasedValueSource.java

@@ -21,7 +21,6 @@
 /**
  * Wraps a Map, and looks up the whole expression as a single key, returning the
  * value mapped to it.
- * @version $Id$
  */
 public class MapBasedValueSource
     extends AbstractValueSource
@@ -31,6 +30,7 @@ public class MapBasedValueSource
 
     /**
      * Construct a new value source to wrap the supplied map.
+     * @param values key,value of mapping.
      */
     public MapBasedValueSource( Map values )
     {

src/main/java/org/codehaus/plexus/interpolation/ObjectBasedValueSource.java

@@ -23,7 +23,6 @@
  * supplied object is the root. Expressions like 'child.name' will translate into
  * 'rootObject.getChild().getName()' for non-boolean properties, and
  * 'rootObject.getChild().isName()' for boolean properties.
- * @version $Id$
  */
 public class ObjectBasedValueSource
     extends AbstractValueSource
@@ -35,6 +34,7 @@ public class ObjectBasedValueSource
      * Construct a new value source, using the supplied object as the root from
      * which to start, and using expressions split at the dot ('.') to navigate
      * the object graph beneath this root.
+     * @param root the root of the graph.
      */
     public ObjectBasedValueSource( Object root )
     {
@@ -43,14 +43,14 @@ public ObjectBasedValueSource( Object root )
     }
 
     /**
-     * Split the expression into parts, tokenized on the dot ('.') character. Then,
+     * <p>Split the expression into parts, tokenized on the dot ('.') character. Then,
      * starting at the root object contained in this value source, apply each part
      * to the object graph below this root, using either 'getXXX()' or 'isXXX()'
      * accessor types to resolve the value for each successive expression part.
-     * Finally, return the result of the last expression part's resolution.
-     * <br/>
-     * <b>NOTE:</b> The object-graph nagivation actually takes place via the
-     * {@link ReflectionValueExtractor} class.
+     * Finally, return the result of the last expression part's resolution.</p>
+     * 
+     * <p><b>NOTE:</b> The object-graph nagivation actually takes place via the
+     * {@link ReflectionValueExtractor} class.</p>
      */
     public Object getValue( String expression )
     {