javadocs cleanup

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@712196 13f79535-47bb-0310-9956-ffa450edef68

9 files changed, 12 insertions, 22 deletions

diff --git a/src/java/org/apache/poi/ss/formula/EvaluationCell.java b/src/java/org/apache/poi/ss/formula/EvaluationCell.java
index c15754b921..b1f467c5c1 100644
--- a/src/java/org/apache/poi/ss/formula/EvaluationCell.java
+++ b/src/java/org/apache/poi/ss/formula/EvaluationCell.java
@@ -21,7 +21,7 @@ package org.apache.poi.ss.formula;
  * Abstracts a cell for the purpose of formula evaluation.  This interface represents both formula
  * and non-formula cells.<br/>
  * 
- * Implementors of this class must implement {@link #hashCode()} and {@link #equals(Object)}
+ * Implementors of this class must implement {@link Object#hashCode()} and {@link Object#equals(Object)}
  * to provide an <em>identity</em> relationship based on the underlying HSSF or XSSF cell <p/>
  * 
  * For POI internal use only
diff --git a/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java b/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java
index 09262a1320..0a4451f651 100644
--- a/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java
+++ b/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java
@@ -18,7 +18,7 @@
 package org.apache.poi.ss.formula;
 
 /**
- * Should be implemented by any {@link Ptg} subclass that needs has an extern sheet index <br/>
+ * Should be implemented by any {@link org.apache.poi.hssf.record.formula.Ptg} subclass that needs has an extern sheet index <br/>
  * 
  * For POI internal use only
  * 
diff --git a/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java b/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java
index b7ccfaf0eb..3dc2c525d5 100644
--- a/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java
+++ b/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java
@@ -18,7 +18,7 @@
 package org.apache.poi.ss.formula;

 

 /**

- * Should be implemented by any {@link Ptg} subclass that needs a workbook to render its formula.

+ * Should be implemented by any {@link org.apache.poi.hssf.record.formula.Ptg} subclass that needs a workbook to render its formula.

  * <br/>

  * 

  * For POI internal use only

diff --git a/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java b/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
index ef5975d3e6..d3955f8796 100644
--- a/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
+++ b/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
@@ -68,7 +68,7 @@ import org.apache.poi.ss.usermodel.Cell;
  * Evaluates formula cells.<p/>
  *
  * For performance reasons, this class keeps a cache of all previously calculated intermediate
- * cell values.  Be sure to call {@link #clearCache()} if any workbook cells are changed between
+ * cell values.  Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between
  * calls to evaluate~ methods on this class.<br/>
  *
  * For POI internal use only
diff --git a/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java b/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java
index 15711195b1..e60104bd31 100644
--- a/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java
+++ b/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java
@@ -17,20 +17,11 @@
 
 package org.apache.poi.ss.usermodel;
 
-import org.apache.poi.hssf.record.formula.eval.BlankEval;
-import org.apache.poi.hssf.record.formula.eval.BoolEval;
-import org.apache.poi.hssf.record.formula.eval.ErrorEval;
-import org.apache.poi.hssf.record.formula.eval.NumberEval;
-import org.apache.poi.hssf.record.formula.eval.StringEval;
-import org.apache.poi.hssf.record.formula.eval.ValueEval;
-import org.apache.poi.hssf.usermodel.HSSFSheet;
-
-
 /**
  * Evaluates formula cells.<p/>
  * 
  * For performance reasons, this class keeps a cache of all previously calculated intermediate
- * cell values.  Be sure to call {@link #clearCache()} if any workbook cells are changed between
+ * cell values.  Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between
  * calls to evaluate~ methods on this class.
  * 
  * @author Amol S. Deshmukh &lt; amolweb at ya hoo dot com &gt;
diff --git a/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java b/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java
index d862125cab..41c0e9ea35 100644
--- a/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java
+++ b/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java
@@ -17,8 +17,8 @@
 package org.apache.poi.ss.usermodel;
 
 /**
- * Common interface for {@link Header} and
- *  {@link Footer}.
+ * Common interface for {@link org.apache.poi.ss.usermodel.Header} and
+ *  {@link org.apache.poi.ss.usermodel.Footer}.
  */
 public interface HeaderFooter {
     /**
diff --git a/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java b/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java
index f804571c09..b26780d85b 100644
--- a/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java
+++ b/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java
@@ -101,28 +101,28 @@ public abstract class CellRangeAddressBase {
 	}
 
 	/**
-	 * @param _firstCol column number for the upper left hand corner
+	 * @param firstCol column number for the upper left hand corner
 	 */
 	public final void setFirstColumn(int firstCol) {
 		_firstCol = firstCol;
 	}
 
 	/**
-	 * @param rowFrom row number for the upper left hand corner
+	 * @param firstRow row number for the upper left hand corner
 	 */
 	public final void setFirstRow(int firstRow) {
 		_firstRow = firstRow;
 	}
 
 	/**
-	 * @param colTo column number for the lower right hand corner
+	 * @param lastCol column number for the lower right hand corner
 	 */
 	public final void setLastColumn(int lastCol) {
 		_lastCol = lastCol;
 	}
 
 	/**
-	 * @param rowTo row number for the lower right hand corner
+	 * @param lastRow row number for the lower right hand corner
 	 */
 	public final void setLastRow(int lastRow) {
 		_lastRow = lastRow;
diff --git a/src/java/org/apache/poi/ss/util/CellRangeAddressList.java b/src/java/org/apache/poi/ss/util/CellRangeAddressList.java
index f5dd8ab7ce..f0444e5e23 100644
--- a/src/java/org/apache/poi/ss/util/CellRangeAddressList.java
+++ b/src/java/org/apache/poi/ss/util/CellRangeAddressList.java
@@ -84,7 +84,6 @@ public class CellRangeAddressList {
 	 * @param firstCol - the upper left hand corner's col
 	 * @param lastRow - the lower right hand corner's row
 	 * @param lastCol - the lower right hand corner's col
-	 * @return the index of this ADDR structure
 	 */
 	public void addCellRangeAddress(int firstRow, int firstCol, int lastRow, int lastCol) {
 		CellRangeAddress region = new CellRangeAddress(firstRow, lastRow, firstCol, lastCol);
diff --git a/src/java/org/apache/poi/ss/util/Region.java b/src/java/org/apache/poi/ss/util/Region.java
index 1ee64c5d02..aee3eef0ac 100644
--- a/src/java/org/apache/poi/ss/util/Region.java
+++ b/src/java/org/apache/poi/ss/util/Region.java
@@ -209,7 +209,7 @@ public class Region implements Comparable {
 	/**
 	 * Convert a List of CellRange objects to an array of regions 
 	 *  
-	 * @param List of CellRange objects
+	 * @param cellRanges list of CellRange objects
 	 * @return regions
 	 */
 	public static Region[] convertCellRangesToRegions(CellRangeAddress[] cellRanges) {