fix JavaDoc errors

Author: volker

src/main/java/com/inet/sass/ScssStylesheet.java

@@ -62,16 +62,11 @@ private ScssStylesheet() {
      * 
      * @param identifier
      *            The file path. If null then null is returned.
-     * @param parentStylesheet
-     *            Style sheet from which to inherit resolvers and encoding. May
-     *            be null.
-     * @param documentHandler
-     *            Instance of document handler. May not be null.
      * @param errorHandler
      *            Instance of error handler. May not be null.
      * @param resolver the used resolver
-     * @return
-     * @throws IOException
+     * @return the loaded ScssStylesheet
+     * @throws IOException if any i/O error occur
      */
     public static ScssStylesheet get( String identifier, SCSSErrorHandler errorHandler, ScssStylesheetResolver resolver ) throws IOException {
         SCSSErrorHandler.set( errorHandler );
@@ -203,7 +198,7 @@ public String toString() {
 
     /**
      * Traverses a node and its children recursively, calling all the
-     * appropriate handlers via {@link Node#traverse()}.
+     * appropriate handlers via {@link Node#traverse}.
      * 
      * The node itself may be removed during the traversal and replaced with
      * other nodes at the same position or later on the child list of its

src/main/java/com/inet/sass/parser/Interpolation.java

@@ -23,8 +23,8 @@
 
 /**
  * Interpolation represents a single instance of interpolation. The string
- * representation of an Interpolation object is "#{<expression>}" (without
- * quotes) where <expression> is the textual representation of the expression of
+ * representation of an Interpolation object is "#{&lt;expression&gt;}" (without
+ * quotes) where &lt;expression&gt; is the textual representation of the expression of
  * the interpolation.
  * 
  * An Interpolation object is evaluated by calling replaceInterpolation(). The
@@ -33,9 +33,6 @@
  * marks are removed from the result. Variables should be replaced with their
  * values and functions and expressions evaluated before calling
  * replaceInterpolation().
- * 
- * @author Vaadin
- * 
  */
 public class Interpolation implements SassListItem {
     private int lineNumber;

src/main/java/com/inet/sass/parser/LexicalUnitImpl.java

@@ -39,11 +39,6 @@
 import com.inet.sass.util.ColorUtil;
 import com.inet.sass.util.StringUtil;
 
-/**
- * @author Philippe Le Hegaret
- * 
- * @modified Sebastian Nyholm @ Vaadin Ltd
- */
 public class LexicalUnitImpl implements SCSSLexicalUnit, SassListItem {
 
     public static final long PRECISION = 100000L;

src/main/java/com/inet/sass/parser/SCSSLexicalUnit.java

@@ -47,19 +47,19 @@ public interface SCSSLexicalUnit {
      */
     public static final short SAC_OPERATOR_EXP          = 6;
     /**
-     * <
+     * &lt;
      */
     public static final short SAC_OPERATOR_LT           = 7;
     /**
-     * >
+     * &gt;
      */
     public static final short SAC_OPERATOR_GT           = 8;
     /**
-     * <=
+     * &lt;=
      */
     public static final short SAC_OPERATOR_LE           = 9;
     /**
-     * >=
+     * &gt;=
      */
     public static final short SAC_OPERATOR_GE           = 10;
     /**
@@ -73,7 +73,7 @@ public interface SCSSLexicalUnit {
     public static final short SAC_INHERIT               = 12;
     /**
      * Integers.
-     * @see #getIntegerValue
+     * @see LexicalUnitImpl#getIntegerValue
      */
     public static final short SAC_INTEGER               = 13;
     /**
@@ -118,7 +118,7 @@ public interface SCSSLexicalUnit {
     public static final short SAC_PERCENTAGE            = 23;
     /**
      * URI: <code>uri(...)</code>.
-     * @see #getStringValue
+     * @see LexicalUnitImpl#getStringValue
      */
     public static final short SAC_URI                   = 24;
     /**
@@ -173,21 +173,21 @@ public interface SCSSLexicalUnit {
 
     /**
      * function <code>rect</code>.
-     * @see #getFunctionName
-     * @see #getParameters
+     * @see LexicalUnitImpl#getFunctionName
+     * @see LexicalUnitImpl#getParameterList
      */
     public static final short SAC_RECT_FUNCTION         = 38;
 
     /**
      * sub expressions <code>(a)</code> <code>(a + b)</code> <code>(normal/none)</code>
-     * @see #getSubValues
+     * @see LexicalUnitImpl#getParameterList
      */
     public static final short SAC_SUB_EXPRESSION        = 40;
 
     /**
      * unknown function.
-     * @see #getFunctionName
-     * @see #getParameters
+     * @see LexicalUnitImpl#getFunctionName
+     * @see LexicalUnitImpl#getParameterList
      */
     public static final short SAC_FUNCTION              = 41;
     /**
@@ -211,7 +211,7 @@ public interface SCSSLexicalUnit {
     static final short        SCSS_INTERPOLATION        = 112; 
 
     /**
-     * "&" placeholder for the parent selector reference
+     * "&amp;" placeholder for the parent selector reference
      */
     static final short        SCSS_PARENT               = 113;
 

src/main/java/com/inet/sass/parser/SassExpression.java

@@ -194,7 +194,7 @@ private boolean containsInterpolation(SassListItem item) {
      *            A list.
      * @param startIndex
      *            The first index included in the search.
-     * @return The smallest index i such that i >= startIndex && list.get(i)
+     * @return The smallest index i such that i <= startIndex && list.get(i)
      *         does not represent whitespace. If no such index exists, returns
      *         list.size().
      */

src/main/java/com/inet/sass/selector/ParentSelector.java

@@ -20,7 +20,7 @@
 import com.inet.sass.parser.StringInterpolationSequence;
 
 /**
- * Single SCSS parent selector "&".
+ * Single SCSS parent selector "&".
  * 
  * The parent selector is not passed to CSS as-is but is replaced with the
  * selectors from the parent block in the case of nested blocks.

src/main/java/com/inet/sass/selector/Selector.java

@@ -67,7 +67,7 @@ public Selector(SimpleSelectorSequence simple) {
     }
 
     /**
-     * Selector with a leading combinator ("> foo")
+     * Selector with a leading combinator ("> foo")
      */
     public Selector(Combinator comb, SimpleSelectorSequence simpl) {
         parts.add(comb);
@@ -163,13 +163,13 @@ public boolean subsumes(Selector that) {
 
     /**
      * Combine a parent selector with this selector, replacing parent reference
-     * selectors (&-selector) in this with replacement if any and return the
+     * selectors (&-selector) in this with replacement if any and return the
      * modified copy of this. If there are no parent reference selectors, simply
      * concatenates the parent selector and this with the DESCENDANT
      * relationship.
      * 
      * @param replacement
-     *            replacement selector, or null in which case & is just removed
+     *            replacement selector, or null in which case & is just removed
      * @return modified copy of this with parent selector prepended or
      *         substituted for the parent reference selector
      */

src/main/java/com/inet/sass/selector/SimpleSelector.java

@@ -22,7 +22,7 @@
  * Simple CSS3 selector such as an id selector or an attribute selector.
  * 
  * {@link SimpleSelector} instances are immutable and
- * {@link #replaceVariables()} returns a modified copy of the selector if
+ * {@link #replaceVariables(ScssContext)} returns a modified copy of the selector if
  * necessary.
  * 
  * Multiple concatenated simple selectors are grouped in

src/main/java/com/inet/sass/tree/MixinDefNode.java

@@ -49,7 +49,6 @@ public String toString() {
      * 
      * @param context context with variables of the caller scope where it is defined
      * @param mixinNode
-     * @return
      */
     public void replaceContentDirective( ScssContext context, MixinNode mixinNode) {
         findAndReplaceContentNodeInChildren( context, this, mixinNode);

src/main/java/com/inet/sass/visitor/BlockNodeHandler.java

@@ -27,6 +27,7 @@
 import com.inet.sass.selector.Selector;
 import com.inet.sass.tree.BlockNode;
 import com.inet.sass.tree.MediaNode;
+import com.inet.sass.tree.NestPropertiesNode;
 import com.inet.sass.tree.Node;
 
 /**
@@ -45,7 +46,7 @@
  * }
  * </pre>
  * 
- * Note that nested properties are handled by {@link NestedNodeHandler}, not
+ * Note that nested properties are handled by {@link NestPropertiesNode}, not
  * here.
  */
 public class BlockNodeHandler {