From: Rainer Klute <klute@apache.org>
Date: Thu, 4 Dec 2003 22:26:01 +0000 (+0000)
Subject: Removed some of the Javadoc errors. Fellow developers, please run "ant javadocs"... 
X-Git-Tag: PERF_BEFORE_MERGE~73
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=b9f9341f45141f063ba1e549661dc1f69b396164;p=poi.git

Removed some of the Javadoc errors. Fellow developers, please run "ant javadocs" and see what can be improved!


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

diff --git a/src/contrib/src/org/apache/poi/hssf/contrib/view/SVFractionalFormat.java b/src/contrib/src/org/apache/poi/hssf/contrib/view/SVFractionalFormat.java
index 47eb588ce0..bfdb23c153 100644
--- a/src/contrib/src/org/apache/poi/hssf/contrib/view/SVFractionalFormat.java
+++ b/src/contrib/src/org/apache/poi/hssf/contrib/view/SVFractionalFormat.java
@@ -64,7 +64,7 @@ import java.text.*;
  * excel but then again it is a lossy formating mode anyway
  *
  * @author     Jason Height
- * @created    15 July 2002
+ * @since      15 July 2002
  */
 public class SVFractionalFormat extends Format {
   private short ONE_DIGIT = 1;
diff --git a/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableCellEditor.java b/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableCellEditor.java
index 5dbfefa0e4..f8811ae628 100644
--- a/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableCellEditor.java
+++ b/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableCellEditor.java
@@ -71,7 +71,7 @@ import org.apache.poi.hssf.util.HSSFColor;
  * nearly completely consists of overridden methods.
  *
  * @author     Jason Height
- * @created    16 July 2002
+ * @since      16 July 2002
  */
 public class SVTableCellEditor extends AbstractCellEditor implements TableCellEditor, ActionListener {
   private static final Color black = getAWTColor(new HSSFColor.BLACK());
diff --git a/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java b/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java
index deb6403ab2..a5259910a4 100644
--- a/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java
+++ b/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java
@@ -65,7 +65,7 @@ import org.apache.poi.hssf.util.*;
  * SVTableCell Editor and Renderer helper functions.
  *
  * @author     Jason Height
- * @created    16 July 2002
+ * @since      16 July 2002
  */
 public class SVTableUtils {
   private final static Hashtable colors = HSSFColor.getIndexHash();
diff --git a/src/contrib/src/org/apache/poi/hssf/usermodel/contrib/HSSFRegionUtil.java b/src/contrib/src/org/apache/poi/hssf/usermodel/contrib/HSSFRegionUtil.java
index db9a0ada54..4339a922d0 100644
--- a/src/contrib/src/org/apache/poi/hssf/usermodel/contrib/HSSFRegionUtil.java
+++ b/src/contrib/src/org/apache/poi/hssf/usermodel/contrib/HSSFRegionUtil.java
@@ -71,7 +71,7 @@ import org.apache.commons.lang.exception.NestableException;
  *  Various utility functions that make working with a region of cells easier.
  *
  *@author     Eric Pugh epugh@upstate.com
- *@created    July 29, 2002
+ *@since      July 29, 2002
  */
 
 public class HSSFRegionUtil {
diff --git a/src/java/org/apache/poi/dev/RecordGenerator.java b/src/java/org/apache/poi/dev/RecordGenerator.java
index 8e9ea7ef67..3b1338d195 100644
--- a/src/java/org/apache/poi/dev/RecordGenerator.java
+++ b/src/java/org/apache/poi/dev/RecordGenerator.java
@@ -65,7 +65,7 @@ import java.io.File;
  *  Description of the Class
  *
  *@author     andy
- *@created    May 10, 2002
+ *@since      May 10, 2002
  */
 public class RecordGenerator {
     /**
diff --git a/src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java b/src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java
index ed80b407f3..697df33d38 100644
--- a/src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java
+++ b/src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java
@@ -63,8 +63,8 @@ import org.apache.poi.hssf.eventusermodel.HSSFUserException;
  * a listener supporting this interface and register it with the HSSFRequest (associating
  * it with Record SID's).
  *
- * @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFRequest
+ * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
+ * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
  * @see org.apache.poi.hssf.HSSFUserException
  *
  * @author Carey Sublette (careysub@earthling.net)
diff --git a/src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java b/src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java
index 3828a53a2f..3f8c38a955 100644
--- a/src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java
+++ b/src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java
@@ -164,7 +164,6 @@ public class HSSFEventFactory
 	 * @see org.apache.poi.poifs.filesystem.POIFSFileSystem#createDocumentInputStream(String)
 	 * @param req       an Instance of HSSFRequest which has your registered listeners
 	 * @param in        a DocumentInputStream obtained from POIFS's POIFSFileSystem object
-	 * @param in        a DocumentInputStream obtained from POIFS's POIFSFileSystem object
 	 * @return 			numeric user-specified result code.
 	 */
 
diff --git a/src/java/org/apache/poi/hssf/eventusermodel/HSSFListener.java b/src/java/org/apache/poi/hssf/eventusermodel/HSSFListener.java
index dbc1f69b75..483b67c678 100644
--- a/src/java/org/apache/poi/hssf/eventusermodel/HSSFListener.java
+++ b/src/java/org/apache/poi/hssf/eventusermodel/HSSFListener.java
@@ -62,8 +62,8 @@ import org.apache.poi.hssf.record.Record;
  * a listener supporting this interface and register it with the HSSFRequest (associating
  * it with Record SID's).
  *
- * @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFRequest
+ * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
+ * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
  * @author  acoliver@apache.org
  */
 
diff --git a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java
index f84b5baa90..870d52fdfc 100644
--- a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java
+++ b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java
@@ -194,7 +194,7 @@ public class BoundSheetRecord
     /**
      * Set the sheetname for this sheet.  (this appears in the tabs at the bottom)
      * @param sheetname the name of the sheet
-     * @thows IllegalArgumentException if sheet name will cause excel to crash. 
+     * @throws IllegalArgumentException if sheet name will cause excel to crash. 
      */
 
     public void setSheetname( String sheetname )
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java
index 855067adf9..688a37b21d 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java
@@ -133,7 +133,7 @@ public class HSSFFooter extends Object {
 
   /**
    * Sets the left string.
-   * @newLeft The string to set as the left side.
+   * @param newLeft The string to set as the left side.
    */
   public void setLeft(String newLeft) {
     left = newLeft;
@@ -150,7 +150,7 @@ public class HSSFFooter extends Object {
 
   /**
    * Sets the center string.
-   * @newLeft The string to set as the center.
+   * @param newCenter The string to set as the center.
    */
   public void setCenter(String newCenter) {
     center = newCenter;
@@ -167,7 +167,7 @@ public class HSSFFooter extends Object {
 
   /**
    * Sets the right string.
-   * @newLeft The string to set as the right side.
+   * @param newRight The string to set as the right side.
    */
   public void setRight(String newRight) {
     right = newRight;
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java b/src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java
index 1345cebe8f..42c5816f4c 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFHeader.java
@@ -133,7 +133,7 @@ public class HSSFHeader extends Object {
 
   /**
    * Sets the left string.
-   * @newLeft The string to set as the left side.
+   * @param newLeft The string to set as the left side.
    */
   public void setLeft(String newLeft) {
     left = newLeft;
@@ -150,7 +150,7 @@ public class HSSFHeader extends Object {
 
   /**
    * Sets the center string.
-   * @newLeft The string to set as the center.
+   * @param newCenter The string to set as the center.
    */
   public void setCenter(String newCenter) {
     center = newCenter;
@@ -167,7 +167,7 @@ public class HSSFHeader extends Object {
 
   /**
    * Sets the right string.
-   * @newLeft The string to set as the right side.
+   * @param newRight The string to set as the right side.
    */
   public void setRight(String newRight) {
     right = newRight;
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
index 799029b9b1..e3fd336168 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
@@ -861,7 +861,7 @@ public class HSSFWorkbook
 	
 	/**
 	 * For the Convenience of Java Programmers maintaining pointers.
-	 * @see setPrintArea(int, String)
+	 * @see #setPrintArea(int, String)
 	 * @param sheetIndex Zero-based sheet index (0 = First Sheet)
 	 * @param startColumn Column to begin printarea
 	 * @param endColumn Column to end the printarea
diff --git a/src/java/org/apache/poi/hssf/util/Region.java b/src/java/org/apache/poi/hssf/util/Region.java
index 582d9524fe..5afd86b18c 100644
--- a/src/java/org/apache/poi/hssf/util/Region.java
+++ b/src/java/org/apache/poi/hssf/util/Region.java
@@ -190,7 +190,7 @@ public class Region
     /**
      * Answers: "is the row/column inside this range?"
      *
-     * @returns boolean - true if the cell is in the range and false if it is not
+     * @return true if the cell is in the range and false if it is not
      */
 
     public boolean contains(int row, short col)
@@ -246,7 +246,7 @@ public class Region
     }
 
     /**
-     * @returns the area contained by this region (number of cells)
+     * @return the area contained by this region (number of cells)
      */
 
     public int getArea()
diff --git a/src/java/org/apache/poi/hssf/util/package.html b/src/java/org/apache/poi/hssf/util/package.html
index 02a94054fb..c78e5e263e 100755
--- a/src/java/org/apache/poi/hssf/util/package.html
+++ b/src/java/org/apache/poi/hssf/util/package.html
@@ -15,6 +15,6 @@ For overviews, tutorials, examples, guides, and tool documentation, please see:
 </ul>
 
 <!-- Put @see and @since tags down here. -->
-@see org.apache.poi.usermodel
+@see org.apache.poi.hssf.usermodel
 </body>
 </html>
diff --git a/src/java/org/apache/poi/util/StringUtil.java b/src/java/org/apache/poi/util/StringUtil.java
index 910ee97819..c856b0181d 100644
--- a/src/java/org/apache/poi/util/StringUtil.java
+++ b/src/java/org/apache/poi/util/StringUtil.java
@@ -65,7 +65,7 @@ import java.util.Arrays;
  *@author     Andrew C. Oliver 
  *@author     Sergei Kozello (sergeikozello at mail.ru) 
  *@author     Toshiaki Kamoshida (kamoshida.toshiaki at future dot co dot jp) 
- *@created    May 10, 2002 
+ *@since      May 10, 2002 
  *@version    1.0 
  */
 public class StringUtil {
@@ -94,7 +94,7 @@ public class StringUtil {
 	 *@exception  IllegalArgumentException        if len is too large (i.e.,     
 	 *      there is not enough data in string to create a String of that     
 	 *      length)     
-	 *@len                                        the length of the final string     
+	 *@param len the length of the final string     
 	 */
 	public static String getFromUnicodeLE(
 		final byte[] string,
@@ -146,7 +146,7 @@ public class StringUtil {
 	 *@exception  IllegalArgumentException        if len is too large (i.e.,     
 	 *      there is not enough data in string to create a String of that     
 	 *      length)     
-	 *@len                                        the length of the final string     
+	 *@param len the length of the final string     
 	 */
 	public static String getFromUnicodeBE(
 		final byte[] string,
diff --git a/src/scratchpad/src/org/apache/poi/hdf/model/hdftypes/PropertyNode.java b/src/scratchpad/src/org/apache/poi/hdf/model/hdftypes/PropertyNode.java
index 12657ccb46..339a059b67 100644
--- a/src/scratchpad/src/org/apache/poi/hdf/model/hdftypes/PropertyNode.java
+++ b/src/scratchpad/src/org/apache/poi/hdf/model/hdftypes/PropertyNode.java
@@ -85,7 +85,7 @@ public class PropertyNode implements Comparable
       return _fcStart;
   }
   /**
-   * @retrun The offset of the end of this property's text.
+   * @return The offset of the end of this property's text.
    */
   public int getEnd()
   {