- 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

src/java/org/apache/poi/hssf/dev/package.html

@@ -15,7 +15,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
 </body>
 </html>

src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java

@@ -25,9 +25,9 @@ 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.eventusermodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFRequest
+ * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
- * @see org.apache.poi.hssf.HSSFUserException
+ * @see org.apache.poi.hssf.eventusermodel.HSSFUserException
  *
  * @author Carey Sublette (careysub@earthling.net)
  *

src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java

@@ -126,7 +126,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.
 	 */
 

src/java/org/apache/poi/hssf/eventusermodel/HSSFListener.java

@@ -24,8 +24,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.eventusermodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFRequest
+ * @see org.apache.poi.hssf.eventusermodel.HSSFRequest
  * @author  acoliver@apache.org
  */
 

src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java

@@ -29,10 +29,10 @@ import org.apache.poi.hssf.record.RecordFactory;
  * An HSSFRequest object should be constructed registering an instance or multiple
  * instances of HSSFListener with each Record.sid you wish to listen for.
  *
- * @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
+ * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
- * @see org.apache.poi.hssf.eventmodel.HSSFListener
+ * @see org.apache.poi.hssf.eventusermodel.HSSFListener
  * @see org.apache.poi.hssf.dev.EFHSSF
- * @see org.apache.poi.hssf.HSSFUserException
+ * @see org.apache.poi.hssf.eventusermodel.HSSFUserException
  * @author  Andrew C. Oliver (acoliver at apache dot org)
  * @author Carey Sublette (careysub@earthling.net)
  */

src/java/org/apache/poi/hssf/model/Sheet.java

@@ -24,7 +24,6 @@ import org.apache.poi.hssf.record.aggregates.RowRecordsAggregate;
 import org.apache.poi.hssf.record.aggregates.ValueRecordsAggregate;
 import org.apache.poi.hssf.record.aggregates.ColumnInfoRecordsAggregate;
 import org.apache.poi.hssf.record.formula.Ptg;
-import org.apache.poi.util.IntList;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.util.POILogger;
 
@@ -2588,7 +2587,7 @@ public class Sheet implements Model
     
     /**
      * Returns all the row page breaks
-     * @return
+     * @return all the row page breaks
      */
     public Iterator getRowBreaks() {
     	return rowBreaks.getBreaksIterator();
@@ -2596,7 +2595,7 @@ public class Sheet implements Model
     
     /**
      * Returns the number of row page breaks
-     * @return
+     * @return the number of row page breaks
      */
     public int getNumRowBreaks(){
     	return (int)rowBreaks.getNumBreaks();
@@ -2604,7 +2603,7 @@ public class Sheet implements Model
     
     /**
      * Returns all the column page breaks
-     * @return
+     * @return all the column page breaks
      */
     public Iterator getColumnBreaks(){
     	return colBreaks.getBreaksIterator();
@@ -2612,7 +2611,7 @@ public class Sheet implements Model
     
     /**
      * Returns the number of column page breaks
-     * @return
+     * @return the number of column page breaks
      */
     public int getNumColumnBreaks(){
     	return (int)colBreaks.getNumBreaks();

src/java/org/apache/poi/hssf/record/BOFRecord.java

@@ -137,7 +137,7 @@ public class BOFRecord
     /**
      * Version number - for BIFF8 should be 0x06
      * @see #VERSION
-     * @param short version to be set
+     * @param version version to be set
      */
 
     public void setVersion(short version)
@@ -153,7 +153,7 @@ public class BOFRecord
      * @see #TYPE_CHART
      * @see #TYPE_EXCEL_4_MACRO
      * @see #TYPE_WORKSPACE_FILE
-     * @param short type to be set
+     * @param type type to be set
      */
 
     public void setType(short type)
@@ -164,7 +164,7 @@ public class BOFRecord
     /**
      * build that wrote this file
      * @see #BUILD
-     * @param short build number to set
+     * @param build build number to set
      */
 
     public void setBuild(short build)
@@ -175,7 +175,7 @@ public class BOFRecord
     /**
      * Year of the build that wrote this file
      * @see #BUILD_YEAR
-     * @param short build year to set
+     * @param year build year to set
      */
 
     public void setBuildYear(short year)
@@ -186,7 +186,7 @@ public class BOFRecord
     /**
      * set the history bit mask (not very useful)
      * @see #HISTORY_MASK
-     * @param int bitmask to set for the history
+     * @param bitmask bitmask to set for the history
      */
 
     public void setHistoryBitMask(int bitmask)
@@ -198,7 +198,7 @@ public class BOFRecord
      * set the minimum version required to read this file
      *
      * @see #VERSION
-     * @param int version to set
+     * @param version version to set
      */
 
     public void setRequiredVersion(int version)

src/java/org/apache/poi/hssf/record/BookBoolRecord.java

@@ -82,7 +82,7 @@ public class BookBoolRecord
     /**
      * set the save ext links flag
      *
-     * @param short flag (0/1 -off/on)
+     * @param flag flag (0/1 -off/on)
      */
 
     public void setSaveLinkValues(short flag)

src/java/org/apache/poi/hssf/record/BoundSheetRecord.java

@@ -158,7 +158,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 )

src/java/org/apache/poi/hssf/record/CodepageRecord.java

@@ -65,7 +65,7 @@ public class CodepageRecord
      * @param id     id must be 0x42 or an exception will be throw upon validation
      * @param size  the size of the data area of the record
      * @param data  data of the record (should not contain sid/len)
-     * @param int offset of the record
+     * @param offset offset of the record
      */
 
     public CodepageRecord(short id, short size, byte [] data, int offset)
@@ -90,7 +90,7 @@ public class CodepageRecord
      * set the codepage for this workbook
      *
      * @see #CODEPAGE
-     * @param codepage - the codepage to set
+     * @param cp the codepage to set
      */
 
     public void setCodepage(short cp)

src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java

@@ -601,11 +601,11 @@ public class ExtendedFormatRecord
     }
 
     /**
-     * set whether or not to use the pattern in this XF instead of the parent XF.
+     * <p>Sets whether or not to use the pattern in this XF instead of the
-     * (foregrount/background)
+     * parent XF (foreground/background).</p>
-     *
+     * 
-     * @param pattern- true if this XF has a different pattern value than its parent,
+     * @param pattern <code>true</code> if this XF has a different pattern
-     *                 false otherwise.
+     *        value than its parent,</code> false</code> otherwise.
      * @see #setIndentionOptions(short)
      */
 
@@ -620,7 +620,7 @@ public class ExtendedFormatRecord
      * set whether or not to use the locking/hidden in this XF instead of the parent XF.
      *
      *
-     * @param options- true if this XF has a different locking or hidden value than its parent,
+     * @param options true if this XF has a different locking or hidden value than its parent,
      *                 false otherwise.
      * @see #setIndentionOptions(short)
      */

src/java/org/apache/poi/hssf/record/PageBreakRecord.java

@@ -27,13 +27,15 @@ import java.util.Map;
 import org.apache.poi.util.LittleEndian;
 
 /**
- * Record that contains the functionality page breaks (horizontal and vertical)
+ * <p>Record that contains the functionality page breaks (horizontal and vertical)</p>
- * <p>
+ * 
- * The other two classes just specifically set the SIDS for record creation
+ * <p>The other two classes just specifically set the SIDS for record creation.</p>
- * @see HorizontalPageBreakRecord
+ * 
- * @see VerticalPageBreakREcord
+ * <p>REFERENCE:  Microsoft Excel SDK page 322 and 420</p>
+ * 
+ * @see HorizontalPageBreakRecord
+ * @see VerticalPageBreakRecord
  * 
- * REFERENCE:  Microsoft Excel SDK page 322 and 420
  * @author Danny Mui (dmui at apache dot org)
  */
 public class PageBreakRecord extends Record {
@@ -242,8 +244,8 @@ public class PageBreakRecord extends Record {
 
     /**
      * Retrieves the region at the row/column indicated
-     * @param main
+     * @param main FIXME: Document this!
-     * @return
+     * @return FIXME: Document this!
      */
     public Break getBreak(short main)
     {

src/java/org/apache/poi/hssf/record/PaletteRecord.java

@@ -168,7 +168,7 @@ public class PaletteRecord
      * If the given index is greater than the current last color index,
      * then black is inserted at every index required to make the palette continuous.
      *
-     * @param i the index to set; if this index is less than 0x8 or greater than
+     * @param byteIndex the index to set; if this index is less than 0x8 or greater than
      * 0x40, then no modification is made
      */
     public void setColor(short byteIndex, byte red, byte green, byte blue)

src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java

@@ -198,7 +198,7 @@ public class Area3DPtg extends Ptg
 
 	/**
 	 * sets the first row to relative or not
-	 * @param isRelative or not.
+	 * @param rel FIXME: Document this!
 	 */
 	public void setFirstRowRelative( boolean rel )
 	{
@@ -215,7 +215,7 @@ public class Area3DPtg extends Ptg
 
 	/**
 	 * set whether the last row is relative or not
-	 * @param last row relative
+	 * @param rel FIXME: Document this!
 	 */
 	public void setLastRowRelative( boolean rel )
 	{

src/java/org/apache/poi/hssf/record/formula/AreaPtg.java

@@ -128,7 +128,7 @@ public class AreaPtg
     }
 
     /**
-     * @param last row number in the area 
+     * @param row last row number in the area 
      */
     public void setLastRow(short row)
     {
@@ -224,7 +224,8 @@ public class AreaPtg
     
     /**
      * set whether the last row is relative or not
-     * @param last row relative
+     * @param rel <code>true</code> if the last row relative, else
+     * <code>false</code>
      */
     public void setLastRowRelative(boolean rel) {
         field_4_last_column=rowRelative.setShortBoolean(field_4_last_column,rel);

src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java

@@ -94,7 +94,7 @@ public class GreaterThanPtg
     
     /** 
      * Implementation of method from Ptg 
-     * @param refs the Sheet References
+     * @param book the Sheet References
      */
     public String toFormulaString(Workbook book)
     {

src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java

@@ -103,7 +103,7 @@ public class LessThanPtg
     
     /** 
      * Implementation of method from Ptg 
-     * @param refs the Sheet References
+     * @param book the Sheet References
      */
     public String toFormulaString(Workbook book)
     {

src/java/org/apache/poi/hssf/record/formula/Ptg.java

@@ -32,7 +32,7 @@ public abstract class Ptg
 {
 
         
-    /** convert infix order ptg list to rpn order ptg list
+    /* convert infix order ptg list to rpn order ptg list
      * @return List ptgs in RPN order
      * @param infixPtgs List of ptgs in infix order
      */

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.
+//     * Constructs an escher graphics object.
-     *
+//     *
-     * @param escherGroup           The escher group to write the graphics calls into.
+//     * @param escherGroup           The escher group to write the graphics calls into.
-     * @param workbook              The workbook we are using.
+//     * @param workbook              The workbook we are using.
-     * @param forecolor             The default foreground color.
+//     * @param forecolor             The default foreground color.
-     */
+//     */
 //    public EscherGraphics( HSSFShapeGroup escherGroup, HSSFWorkbook workbook, Color forecolor)
 //    {
 //        this(escherGroup, workbook, forecolor, 1.0f);

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)

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;

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 lowlevel Workbook object associated with the sheet.
-     * @param book the Workbook */
+     */
     
     protected HSSFName(Workbook book, NameRecord name) {
         this.book = book;

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)

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
+     * @param row FIXME: Document this!
-     * @return
+     * @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
+     * @param column FIXME: Document this!
-     * @return
+     * @return FIXME: Document this!
      */
     public boolean isColumnBroken(short column) {
     	return sheet.isColumnBroken(column);

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

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>

src/java/org/apache/poi/hssf/util/Region.java

@@ -152,7 +152,8 @@ 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 <code>true</code> if the cell is in the range and
+     * <code>false</code> if it is not
      */
 
     public boolean contains(int row, short col)
@@ -208,7 +209,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()

src/java/org/apache/poi/hssf/util/package.html

@@ -15,7 +15,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.usermodel
 </body>
 </html>

src/java/org/apache/poi/poifs/common/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.hpsf
 </body>
 </html>

src/java/org/apache/poi/poifs/dev/package.html

@@ -15,7 +15,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.poifs
 </body>
 </html>

src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java

@@ -226,7 +226,6 @@ public class POIFSDocumentPath
      * <p>Returns the path's parent or <code>null</code> if this path
      * is the root path.</p>
      *
-     * @author Rainer Klute (klute@rainer-klute.de)
      * @since 2002-01-24
      * @return path of parent, or null if this path is the root path
      */
@@ -250,10 +249,9 @@ public class POIFSDocumentPath
      * <p>Returns a string representation of the path. Components are
      * separated by the platform-specific file separator.</p>
      *
-     * @author Rainer Klute (klute@rainer-klute.de)
-     * @since 2002-01-24
-     *
      * @return string representation
+     *
+     * @since 2002-01-24
      */
 
     public String toString()

src/java/org/apache/poi/poifs/storage/package.html

@@ -15,8 +15,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.poifs
-@see org.apache.poi.poifs.filesystem
 </body>
 </html>

src/java/org/apache/poi/util/package.html

@@ -15,8 +15,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.hpsf
 </body>
 </html>

src/scratchpad/src/org/apache/poi/hwpf/HWPFDocument.java

@@ -207,7 +207,7 @@ public class HWPFDocument
 
   /**
    * Returns the character length of a document.
-   * @return
+   * @return the character length of a document
    */
   public int characterLength()
   {

src/scratchpad/src/org/apache/poi/hwpf/model/CHPFormattedDiskPage.java

@@ -53,8 +53,6 @@ public class CHPFormattedDiskPage extends FormattedDiskPage
     /**
      * This constructs a CHPFormattedDiskPage from a raw fkp (512 byte array
      * read from a Word file).
-     *
-     * @param fkp The 512 byte array to read data from
      */
     public CHPFormattedDiskPage(byte[] documentStream, int offset, int fcMin)
     {

src/scratchpad/src/org/apache/poi/hwpf/model/FIBLongHandler.java

@@ -21,8 +21,6 @@ import java.io.IOException;
 
 import org.apache.poi.util.LittleEndian;
 
-import org.apache.poi.hwpf.model.io.HWPFOutputStream;
-
 public class FIBLongHandler
 {
   public static final int CBMAC = 0;
@@ -64,8 +62,8 @@ public class FIBLongHandler
 
   /**
    * Refers to a 32 bit windows "long" same as a Java int
-   * @param longCode
+   * @param longCode FIXME: Document this!
-   * @return
+   * @return FIXME: Document this!
    */
   public int getLong(int longCode)
   {

src/scratchpad/src/org/apache/poi/hwpf/model/PAPFormattedDiskPage.java

@@ -58,8 +58,6 @@ public class PAPFormattedDiskPage extends FormattedDiskPage
 
     /**
      * Creates a PAPFormattedDiskPage from a 512 byte array
-     *
-     * @param fkp a 512 byte array.
      */
     public PAPFormattedDiskPage(byte[] documentStream, byte[] dataStream, int offset, int fcMin)
     {

src/scratchpad/src/org/apache/poi/hwpf/model/PropertyNode.java

@@ -38,7 +38,7 @@ public abstract class PropertyNode implements Comparable, Cloneable
   /**
    * @param fcStart The start of the text for this property.
    * @param fcEnd The end of the text for this property.
-   * @param grpprl The property description in compressed form.
+   * @param buf FIXME: Old documentation is: "grpprl The property description in compressed form."
    */
   protected PropertyNode(int fcStart, int fcEnd, Object buf)
   {

src/scratchpad/src/org/apache/poi/hwpf/model/StyleSheet.java

@@ -64,7 +64,7 @@ public class StyleSheet implements HDFType
   /**
    * StyleSheet constructor. Loads a document's stylesheet information,
    *
-   * @param styleSheet A byte array containing a document's raw stylesheet
+   * @param tableStream A byte array containing a document's raw stylesheet
    *        info. Found by using FileInformationBlock.getFcStshf() and
    *        FileInformationBLock.getLcbStshf()
    */