- Ironed out a whole bunch of Javadoc issues. Not that the documentation is any better now, but at least Javadoc complains no longer.

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

8 files changed, 25 insertions, 29 deletions

diff --git a/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java b/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
index 4ddac6a6ad..0bf84d885c 100644
--- a/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
+++ b/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
@@ -109,13 +109,13 @@ public class EscherGraphics
         this.verticalPixelsPerPoint = 1 / verticalPointsPerPixel;
     }
 
-    /**
-     * Constructs an escher graphics object.
-     *
-     * @param escherGroup           The escher group to write the graphics calls into.
-     * @param workbook              The workbook we are using.
-     * @param forecolor             The default foreground color.
-     */
+//    /**
+//     * Constructs an escher graphics object.
+//     *
+//     * @param escherGroup           The escher group to write the graphics calls into.
+//     * @param workbook              The workbook we are using.
+//     * @param forecolor             The default foreground color.
+//     */
 //    public EscherGraphics( HSSFShapeGroup escherGroup, HSSFWorkbook workbook, Color forecolor)
 //    {
 //        this(escherGroup, workbook, forecolor, 1.0f);
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java
index f910309a47..b760082af0 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java
@@ -162,7 +162,7 @@ public class HSSFFont
     /**
      * set the font height in unit's of 1/20th of a point.  Maybe you might want to
      * use the setFontHeightInPoints which matches to the familiar 10, 12, 14 etc..
-     * @param short - height in 1/20ths of a point
+     * @param height height in 1/20ths of a point
      * @see #setFontHeightInPoints(short)
      */
 
@@ -173,7 +173,7 @@ public class HSSFFont
 
     /**
      * set the font height
-     * @param short - height in the familiar unit of measure - points
+     * @param height height in the familiar unit of measure - points
      * @see #setFontHeight(short)
      */
 
@@ -207,7 +207,7 @@ public class HSSFFont
 
     /**
      * set whether to use italics or not
-     * @param italics or not
+     * @param italic italics or not
      */
 
     public void setItalic(boolean italic)
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java
index 16f65f6db8..464513b9cf 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFooter.java
@@ -93,7 +93,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;
@@ -110,7 +110,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;
@@ -127,7 +127,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/HSSFName.java b/src/java/org/apache/poi/hssf/usermodel/HSSFName.java
index 4f2c9bb6ca..2b4edd8fff 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFName.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFName.java
@@ -35,8 +35,8 @@ public class HSSFName {
      *
      * @see org.apache.poi.hssf.usermodel.HSSFWorkbook#createName()
      * @param name the Name Record
-     * @param book - lowlevel Workbook object associated with the sheet.
-     * @param book the Workbook */
+     * @param book lowlevel Workbook object associated with the sheet.
+     */
     
     protected HSSFName(Workbook book, NameRecord name) {
         this.book = book;
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
index 4c156e63b0..761887a09f 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
@@ -78,7 +78,7 @@ public class HSSFRow
      * @param book low-level Workbook object containing the sheet that contains this row
      * @param sheet low-level Sheet object that contains this Row
      * @param rowNum the row number of this row (0 based)
-     * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(short)
+     * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(int)
      */
 
     //protected HSSFRow(Workbook book, Sheet sheet, short rowNum)
@@ -103,7 +103,7 @@ public class HSSFRow
      * @param book low-level Workbook object containing the sheet that contains this row
      * @param sheet low-level Sheet object that contains this Row
      * @param record the low level api object this row should represent
-     * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(short)
+     * @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(int)
      */
 
     protected HSSFRow(Workbook book, Sheet sheet, RowRecord record)
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
index 8c3eb00d53..991d79ceb7 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
@@ -1115,7 +1115,7 @@ public class HSSFSheet
     
     /**
      * Sets a page break at the indicated row
-     * @param row
+     * @param row FIXME: Document this!
      */
     public void setRowBreak(int row) {
     	validateRow(row);
@@ -1124,8 +1124,8 @@ public class HSSFSheet
 
     /**
      * Determines if there is a page break at the indicated row
-     * @param row
-     * @return
+     * @param row FIXME: Document this!
+     * @return FIXME: Document this!
      */
     public boolean isRowBroken(int row) {
     	return sheet.isRowBroken(row);
@@ -1141,7 +1141,7 @@ public class HSSFSheet
     
     /**
      * Retrieves all the horizontal page breaks
-     * @return
+     * @return all the horizontal page breaks
      */
     public int[] getRowBreaks(){
     	//we can probably cache this information, but this should be a sparsely used function 
@@ -1157,7 +1157,7 @@ public class HSSFSheet
 
     /**
      * Retrieves all the vertical page breaks
-     * @return
+     * @return all the vertical page breaks
      */
     public short[] getColumnBreaks(){
     	//we can probably cache this information, but this should be a sparsely used function 
@@ -1183,8 +1183,8 @@ public class HSSFSheet
 
     /**
      * Determines if there is a page break at the indicated column
-     * @param column
-     * @return
+     * @param column FIXME: Document this!
+     * @return FIXME: Document this!
      */
     public boolean isColumnBroken(short column) {
     	return sheet.isColumnBroken(column);
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
index 57226d667b..33e9e7622e 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
@@ -242,7 +242,6 @@ public class HSSFWorkbook
      * Will throw IllegalArgumentException if the name is greater than 31 chars
      * or contains /\?*[]
      * @param sheet number (0 based)
-     * @param sheet name
      */
     public void setSheetName(int sheet, String name)
     {
@@ -875,7 +874,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/usermodel/package.html b/src/java/org/apache/poi/hssf/usermodel/package.html
index 36add03e01..c9bbb1e77b 100755
--- a/src/java/org/apache/poi/hssf/usermodel/package.html
+++ b/src/java/org/apache/poi/hssf/usermodel/package.html
@@ -14,8 +14,5 @@ For overviews, tutorials, examples, guides, and tool documentation, please see:
 <li><a href="http://jakarta.apache.org/poi">Jakarta POI Project</a>
 </ul>
 
-<!-- Put @see and @since tags down here. -->
-@see org.apache.poi.hssf
-@see org.apache.poi.hssf.eventmodel
 </body>
 </html>