Fix javadoc comments in filters/xmerge/pexcel

22 files changed, 119 insertions, 133 deletions

diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BeginningOfFile.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BeginningOfFile.java
index df45b708d89c..fe61eb3c5ee8 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BeginningOfFile.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BeginningOfFile.java
@@ -49,8 +49,7 @@ public class BeginningOfFile implements BIFFRecord {
    /**
     *  Constructor that initializes the member values.
     *
-    *  @param  ver  Version Number
-    *               Substream type (workbook = 0x05, worksheet = 0x10)
+    *  @param  global   True for a workbook, false for a worksheet
     */
     public BeginningOfFile(boolean global) {
         setVersion((short) 271);
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BlankCell.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BlankCell.java
index da826a8d9058..3ce6b6535e9a 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BlankCell.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BlankCell.java
@@ -52,10 +52,9 @@ public class BlankCell extends CellValue {
     /**
       * Constructs a <code>BlankCell</code> using specified attributes
      *
-     * @param row row number
-     * @param col column number
-     * @param cellContents contents of the cell
-     * @param ixfe font index
+     * @param row     row number
+     * @param column  column number
+     * @param ixfe    font index
       */
     public BlankCell(int row, int column, int ixfe) throws IOException {
 
@@ -87,7 +86,7 @@ public class BlankCell extends CellValue {
     /**
      * Reads a BlankCell <code>InputStream</code>
      *
-     * @param   is InputStream containing a BlankCell.
+     * @param   input InputStream containing a BlankCell.
      */
     public int read(InputStream input) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoolErrCell.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoolErrCell.java
index 9a370ccd8a59..d617837a5724 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoolErrCell.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoolErrCell.java
@@ -31,7 +31,6 @@ import java.io.OutputStream;
 import java.io.InputStream;
 import java.io.IOException;
 
-
 import org.openoffice.xmerge.util.Debug;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
 
@@ -46,11 +45,11 @@ public class BoolErrCell extends CellValue {
      /**
      * Constructs a BoolErrCell from arguments
       *
-     * @param row row number
-     * @param col column number
-     * @param ixfe font index
+     * @param row      row number
+     * @param column   column number
+     * @param ixfe     font index
      * @param bBoolErr Boolean value or error value
-     * @param fError Boolean error flag
+     * @param fError   Boolean error flag
       */
     public BoolErrCell(int row, int column, int ixfe, int bBoolErr, int fError) throws IOException {
 
@@ -82,7 +81,7 @@ public class BoolErrCell extends CellValue {
     /**
      * Writes a <code>BoolErrCell</code> to the specified <code>Outputstream</code>
      *
-     * @param os the <code>OutputStream</code> to write to
+     * @param output the <code>OutputStream</code> to write to
      */
     public void write(OutputStream output) throws IOException {
 
@@ -99,7 +98,7 @@ public class BoolErrCell extends CellValue {
     /**
      * Reads a BoolErrCell from the <code>InputStream</code>
       *
-      * @param  is InputStream containing a BoolErrCell
+      * @param  input InputStream containing a BoolErrCell
       */
     public int read(InputStream input) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoundSheet.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoundSheet.java
index 679224634bfa..0d2cc0669c6c 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoundSheet.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/BoundSheet.java
@@ -99,7 +99,7 @@ public class BoundSheet implements BIFFRecord {
      /**
      * Write this particular <code>BIFFRecord</code> to the <code>OutputStream</code>
      *
-     * @param ouput the <code>OutputStream</code>
+     * @param output the <code>OutputStream</code>
      */
     public void write(OutputStream output) throws IOException {
 
@@ -115,7 +115,7 @@ public class BoundSheet implements BIFFRecord {
       * Reads a BoundSheet from the <code>InputStream</code> The byte array
      * must be twice the size of the String as it uses unicode.
       *
-      * @param  is InputStream containing the record data
+      * @param  input InputStream containing the record data
       */
     public int read(InputStream input) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/CellValue.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/CellValue.java
index c09cde5a32c1..1aa6da472ccb 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/CellValue.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/CellValue.java
@@ -40,7 +40,7 @@ public abstract class CellValue implements BIFFRecord {
     protected byte   col;
     protected byte[] ixfe = new byte[2];
 
-       /**
+     /**
      * Get the row number of this cell
      *
      * @return the row number of this cell
@@ -85,9 +85,9 @@ public abstract class CellValue implements BIFFRecord {
     }
 
     /**
-     * Set the row number of this cell
+     * Set the column number of this cell
      *
-     * @param col sets the row number for this cell
+     * @param col sets the column number for this cell
      */
     public void setCol(int col) {
         this.col = (byte) (col - 1);        // The cols start at 1
@@ -96,7 +96,7 @@ public abstract class CellValue implements BIFFRecord {
     /**
      * Writes basic cell value attributes to the specified <code>Outputstream</code>
      *
-     * @param os the <code>OutputStream</code> to write to
+     * @param output the <code>OutputStream</code> to write to
      */
     public void write(OutputStream output) throws IOException {
 
@@ -106,9 +106,9 @@ public abstract class CellValue implements BIFFRecord {
     }
 
     /**
-     * Writes a<code>LabelCell</code> to the specified <code>Outputstream</code>
+     * Reads a <code>LabelCell</code> from the specified <code>Inputstream</code>
      *
-     * @param os the <code>OutputStream</code> to write to
+     * @param input the <code>InputStream</code> to read from
      */
     public int read(InputStream input) throws IOException {
 
@@ -124,7 +124,6 @@ public abstract class CellValue implements BIFFRecord {
         return numOfBytesRead;
     }
 
-
     /**
      * Returns the contents of the cell as a String
      *
@@ -133,4 +132,3 @@ public abstract class CellValue implements BIFFRecord {
     abstract public String getString() throws IOException;
 
 }
-
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ColInfo.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ColInfo.java
index 6ce59c7ca72c..14426241419c 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ColInfo.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ColInfo.java
@@ -54,8 +54,8 @@ public class ColInfo implements BIFFRecord {
       *
       * @param  colFirst    the first column this formatting applies to
       * @param  colLast     last column this formatting applies to
-      * @param  coldx       column width
-      * @param  grbit       options flags
+      * @param  colDX       column width
+      * @param  ixfe        index for formatting
       */
     public ColInfo(int colFirst, int colLast, int colDX, int ixfe) {
         this.colFirst   = EndianConverter.writeShort((short)colFirst);
@@ -119,18 +119,18 @@ public class ColInfo implements BIFFRecord {
     }
 
     /**
-     * Get the hex code for this particular <code>BIFFRecord</code>
+     * Get the first column that this formatting applies to.
      *
-     * @return the hex code for <code>ColInfo</code>
+     * @return The first column.
      */
     public short getFirst() {
         return EndianConverter.readShort(colFirst);
     }
 
     /**
-     * Get the hex code for this particular <code>BIFFRecord</code>
+     * Get the last column that this formatting applies to.
      *
-     * @return the hex code for <code>ColInfo</code>
+     * @return The last column.
      */
     public short getLast() {
         return EndianConverter.readShort(colLast);
@@ -139,7 +139,7 @@ public class ColInfo implements BIFFRecord {
     /**
      * Writes a ColInfo to the specified <code>Outputstream</code>
      *
-     * @param os the <code>OutputStream</code> to write to
+     * @param output the <code>OutputStream</code> to write to
      */
     public void write(OutputStream output) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefColWidth.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefColWidth.java
index b3e3a8e6b0e3..b6b3baace2de 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefColWidth.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefColWidth.java
@@ -44,18 +44,21 @@ public class DefColWidth implements BIFFRecord {
     private byte[] coldx = new byte[2];
     private byte[] ixfe  = new byte[2];
 
-/**
- * Constructs a pocket Excel Document from the
- * <code>InputStream</code> and assigns it the document name passed in
- *
- * @param   is InputStream containing a Pocket Excel Data file.
- */
+    /**
+     * Default constructor. Sets width to 9.
+     */
     public DefColWidth() {
         grbit   = new byte[] {0x00, 0x00};
         coldx   = new byte[] {0x00, 0x09};
         ixfe    = new byte[] {0x00, 0x00};
     }
 
+    /**
+     * Constructs a pocket Excel Document from the
+     * <code>InputStream</code> and assigns it the document name passed in
+     *
+     * @param   is InputStream containing a Pocket Excel Data file.
+     */
     public DefColWidth(InputStream is) throws IOException {
         read(is);
     }
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefRowHeight.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefRowHeight.java
index 454a5ed87520..f2c5e83bc0e6 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefRowHeight.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefRowHeight.java
@@ -44,10 +44,7 @@ public class DefRowHeight implements BIFFRecord {
     private byte[] unknown2 = new byte[2];
 
     /**
-      * Constructs a pocket Excel Document from the
-      * <code>InputStream</code> and assigns it the document name passed in
-      *
-      * @param  is InputStream containing a Pocket Excel Data file.
+      * Default constructor. Sets something unknown to 255.
       */
     public DefRowHeight() {
         unknown1 = new byte[] {(byte)0x00, (byte)0x00};
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefinedName.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefinedName.java
index 0f8c535a9b92..af97015db745 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefinedName.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/DefinedName.java
@@ -55,9 +55,10 @@ public class DefinedName implements BIFFRecord {
     private Workbook wb;
 
     /**
-      * Constructs a Defined Name from the <code>InputStream</code>
+      * Constructs a Defined Name from an existing <code>NameDefinition</code>
       *
-      * @param  is InputStream containing the record data
+      * @param  nd The name definition.
+      * @param  wb The workbook we are defined in.
       */
     public DefinedName(NameDefinition nd, Workbook wb) throws IOException {
 
@@ -74,10 +75,12 @@ public class DefinedName implements BIFFRecord {
         grbit = EndianConverter.writeShort((short)0);
         ixals[0] = (byte)0xFF;ixals[1] = (byte)0xFF;
     }
+
     /**
       * Constructs a Defined Name from the <code>InputStream</code>
       *
       * @param  is InputStream containing the record data
+      * @param  wb The workbook we are defined in.
       */
     public DefinedName(InputStream is, Workbook wb) throws IOException {
 
@@ -99,7 +102,7 @@ public class DefinedName implements BIFFRecord {
       * Reads a Defined Name from the <code>InputStream</code> The byte array
      * must be twice the size of the String as it uses unicode.
       *
-      * @param  is InputStream containing the record data
+      * @param  input InputStream containing the record data
       */
     public int read(InputStream input) throws IOException {
 
@@ -115,8 +118,6 @@ public class DefinedName implements BIFFRecord {
         rgce = new byte[EndianConverter.readShort(cce)];
         input.read(rgce, 0, EndianConverter.readShort(cce));
 
-
-
         Debug.log(Debug.TRACE, "\tgrbit : "+ EndianConverter.readShort(grbit) +
                             " cch : " + cch +
                             " cce : " + EndianConverter.readShort(cce) +
@@ -130,7 +131,7 @@ public class DefinedName implements BIFFRecord {
      /**
      * Write this particular <code>BIFFRecord</code> to the <code>OutputStream</code>
      *
-     * @param ouput the <code>OutputStream</code>
+     * @param output the <code>OutputStream</code>
      */
     public void write(OutputStream output) throws IOException {
 
@@ -143,7 +144,6 @@ public class DefinedName implements BIFFRecord {
             cce = EndianConverter.writeShort((short) 0);
         }
 
-
         output.write(getBiffType());
         output.write(grbit);
         output.write(cch);
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ExtendedFormat.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ExtendedFormat.java
index 5165efd84460..2ae615dc93ce 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ExtendedFormat.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/ExtendedFormat.java
@@ -280,8 +280,8 @@ org.openoffice.xmerge.converter.xml.OfficeConstants {
     /**
      * Compare two ExtendedFormat to see if the font index is the same
      *
-     * @param the ExtendedFormat to be used in the comaprison
-     * @return boolean if the two are the same otherwise false
+     * @param  rhs The ExtendedFormat to be used in the comaprison
+     * @return True if the two are the same otherwise false
      */
     public boolean compareTo(ExtendedFormat rhs) {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FloatNumber.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FloatNumber.java
index 8d702640a500..1359134400ed 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FloatNumber.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FloatNumber.java
@@ -43,8 +43,7 @@ public class FloatNumber extends CellValue {
     protected byte[] num  = new byte[8];
 
     /**
-      * Constructs a pocket Excel Document from the
-      * <code>InputStream</code> and assigns it the document name passed in
+      * Constructs a FloatNumber by reading from an InputStream.
      *
       * @param  is InputStream containing a Pocket Excel Data file.
       */
@@ -55,10 +54,10 @@ public class FloatNumber extends CellValue {
     /**
       * Constructs a <code>FloatNumber</code> using specified attributes
      *
-     * @param row row number
-     * @param col column number
+     * @param row          row number
+     * @param column       column number
      * @param cellContents contents of the cell
-     * @param ixfe font index
+     * @param ixfe         font index
       */
     public FloatNumber(int row, int column, String cellContents, int ixfe) throws IOException {
 
@@ -104,7 +103,6 @@ public class FloatNumber extends CellValue {
         Debug.log(Debug.TRACE,"Writing FloatNumber record");
     }
 
-
     /**
      * Gets the numerical value the cell represents
      *
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FontDescription.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FontDescription.java
index 61d9746c80d3..1462e965ddd0 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FontDescription.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/FontDescription.java
@@ -39,7 +39,6 @@ import org.openoffice.xmerge.util.EndianConverter;
 import org.openoffice.xmerge.util.ColourConverter;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
 
-
 /**
  * Represents a BIFF Record descibing a font used
  */
@@ -61,11 +60,9 @@ public class FontDescription implements BIFFRecord {
     public static final int ITALIC      = 0x02;
 
     /**
-      * Constructs a FontDescription from the bold italic and undelrine attributes
+      * Constructs a FontDescription from a Format.
       *
-      * @param  italic      Italic attribute
-      * @param  bold        Bold attribute
-      * @param  underline   Underline attribute
+      * @param  fmt The <code>Format</code> to use as source.
       */
     public FontDescription(Format fmt) throws IOException {
 
@@ -86,7 +83,6 @@ public class FontDescription implements BIFFRecord {
         if (fmt.getAttribute(Format.UNDERLINE))
             uls |= UNDERLINE;
 
-
         bFamily     = 0;
         bCharSet    = 0;
 
@@ -188,7 +184,6 @@ public class FontDescription implements BIFFRecord {
         return true;
     }
 
-
     /**
       * Constructs a Font Description from the <code>InputStream</code>
       *
@@ -234,7 +229,7 @@ public class FontDescription implements BIFFRecord {
     /**
       * Constructs a Font Description from the <code>InputStream</code>
       *
-      * @param  is InputStream containing a <code>FontDescription</code>
+      * @param  input InputStream containing a <code>FontDescription</code>
       */
     public int read(InputStream input) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Formula.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Formula.java
index a073883b2e8e..90c28a1f7dd3 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Formula.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Formula.java
@@ -39,7 +39,6 @@ import org.openoffice.xmerge.converter.xml.sxc.pexcel.records.formula.FormulaHel
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.records.Workbook;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
 
-
 /**
  * Represents a BIFF Record describing a formula
  */
@@ -52,14 +51,15 @@ public class Formula extends CellValue implements OfficeConstants {
     private FormulaHelper fh = new FormulaHelper();
 
     /**
-      * Constructs a <code>Formula</code> using specified attributes
+     * Constructs a <code>Formula</code> using specified attributes
      *
-     * @param row row number
-     * @param col column number
+     * @param row          row number
+     * @param column       column number
      * @param cellContents contents of the cell
-     * @param ixfe font index
-     * @param value the value of the cell
-      */
+     * @param ixfe         font index
+     * @param fmt          cell format description.
+     * @param wb           the workbook we are defined in.
+     */
     public Formula(int row, int column, String cellContents, int ixfe, Format fmt, Workbook wb)
     throws Exception {
 
@@ -116,7 +116,7 @@ public class Formula extends CellValue implements OfficeConstants {
       * Translates a <code>String</code> written in infix which represents a
      * formula into a byte[] what can be written to pocket excel file.
       *
-      * @param  formula string
+      * @param  inFormula formula string
       */
     public void setFormula(String inFormula) throws Exception {
 
@@ -129,6 +129,7 @@ public class Formula extends CellValue implements OfficeConstants {
       * <code>InputStream</code>
       *
       * @param  is InputStream containing a Pocket Excel Data file.
+      * @param  wb The workbook we are defined in.
       */
     public Formula(InputStream is, Workbook wb) throws IOException {
         read(is);
@@ -148,6 +149,7 @@ public class Formula extends CellValue implements OfficeConstants {
      * Reads the formula data members from the stream. Byte arrays for Strings
      * are doubled as they are stored as  unicode
      *
+     * @param input  the input stream to read from.
      * @return total number of bytes read
      */
     public int read(InputStream input) throws IOException {
@@ -175,7 +177,7 @@ public class Formula extends CellValue implements OfficeConstants {
      /**
      * Writes the Formula record to the <code>OutputStream</code>
      *
-     * @param the <code>OutputStream</code> being written to
+     * @param output The <code>OutputStream</code> being written to
      */
     public void write(OutputStream output) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java
index d4ad28cc7e2b..4d4ef3029823 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/LabelCell.java
@@ -35,7 +35,6 @@ import org.openoffice.xmerge.util.Debug;
 import org.openoffice.xmerge.util.EndianConverter;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
 
-
 /**
  * Reperesent a BIFF Record descibing a cell containing a string
  */
@@ -47,10 +46,10 @@ public class LabelCell extends CellValue {
     /**
       * Constructs a <code>LabelCell</code> using specified attributes
      *
-     * @param row row number
-     * @param col column number
+     * @param row          row number
+     * @param column       column number
      * @param cellContents contents of the cell
-     * @param ixfe font index
+     * @param ixfe         font index
       */
     public LabelCell(int row, int column, String cellContents, int ixfe)
     throws IOException {
@@ -73,7 +72,7 @@ public class LabelCell extends CellValue {
     /**
      * Writes a <code>LabelCell</code> to the specified <code>Outputstream</code>
      *
-     * @param os the <code>OutputStream</code> to write to
+     * @param output The <code>OutputStream</code> to write to
      */
     public void write(OutputStream output) throws IOException {
 
@@ -117,7 +116,6 @@ public class LabelCell extends CellValue {
         return numOfBytesRead;
     }
 
-
     /**
      * Gets the <code>String</code> representing the cells contents
      *
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java
index b65d1027f969..8c1547e3f2a1 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Pane.java
@@ -124,9 +124,11 @@ public class Pane implements BIFFRecord {
     }
 
     /**
-     * Get the hex code for this particular <code>BIFFRecord</code>
+     * Set the pane number
+     * 0 - bottom right, 1 - top right
+     * 2 - bottom left, 3 - top left
      *
-     * @return the hex code for <code>Pane</code>
+     * @param paneNumber the pane number
      */
     public void setPaneNumber(int paneNumber) {
         pnnAcct = (byte) paneNumber;
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Row.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Row.java
index 8e3067d26c6b..5e36575d4296 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Row.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Row.java
@@ -35,7 +35,6 @@ import org.openoffice.xmerge.util.Debug;
 import org.openoffice.xmerge.util.EndianConverter;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
 
-
 /**
  * Represents s BIFF Record that describes the format of a column
  */
@@ -94,7 +93,7 @@ public class Row implements BIFFRecord {
     }
 
     /**
-     * Get the rown number for this style
+     * Get the row number
      *
      * @return the row this style applies to
      */
@@ -105,7 +104,7 @@ public class Row implements BIFFRecord {
     /**
      * Reads a Row from an <code>InputStream</code>
      *
-     * @param   is InputStream containing a Pane Record
+     * @param   input InputStream containing a Row Record
      */
     public int read(InputStream input) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java
index 308eae29227e..72dc960880b5 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Selection.java
@@ -36,7 +36,6 @@ import org.openoffice.xmerge.util.Debug;
 import org.openoffice.xmerge.util.EndianConverter;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
 
-
 /**
  * Represents a BIFF Record that describes the selected area of a worksheet
  */
@@ -81,9 +80,9 @@ public class Selection implements BIFFRecord {
     }
 
     /**
-     * Get the hex code for this particular <code>BIFFRecord</code>
+     * Get the active cell for this particular <code>BIFFRecord</code>
      *
-     * @return the hex code for <code>Selection</code>
+     * @return the cell position
      */
     public Point getActiveCell() {
         Point p = new Point(colActive, EndianConverter.readShort(rwActive));
@@ -91,9 +90,9 @@ public class Selection implements BIFFRecord {
     }
 
     /**
-     * Get the hex code for this particular <code>BIFFRecord</code>
+     * Set the active cell position for this particular <code>BIFFRecord</code>
      *
-     * @return the hex code for <code>Selection</code>
+     * @param p The active cell position
      */
     public void setActiveCell(Point p) {
 
@@ -104,7 +103,7 @@ public class Selection implements BIFFRecord {
     /**
      * Reads a Selection Record from the <code>InputStream</code>
      *
-     * @param   is InputStream containing a Pocket Excel Data file.
+     * @param   input InputStream containing a Pocket Excel Data file.
      */
     public int read(InputStream input) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/StringValue.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/StringValue.java
index c516eca69b1b..af33a2a6b8d0 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/StringValue.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/StringValue.java
@@ -36,7 +36,6 @@ import org.openoffice.xmerge.util.Debug;
 import org.openoffice.xmerge.util.EndianConverter;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
 
-
 /**
  * Represents a BIFF Record that describes the value of a formula that
  * evaluates to a string
@@ -47,9 +46,9 @@ public class StringValue implements BIFFRecord {
     private byte[]  rgch;
 
     /**
-      * Constructs a StringValue Record from an <code>InputStream</code>
+      * Constructs a StringValue Record from a string
       *
-      * @param  is InputStream containing a StringValue Record
+      * @param  str String containing value
       */
     public StringValue(String str) throws IOException {
         cch = EndianConverter.writeShort((short) str.length());
@@ -78,7 +77,7 @@ public class StringValue implements BIFFRecord {
        /**
       * Reads a StringVlaue Record from an <code>InputStream</code>
       *
-      * @param  is InputStream containing a StringValue Record
+      * @param  input InputStream containing a StringValue Record
       */
     public int read(InputStream input) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window1.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window1.java
index c060db90d60d..d2c256e41e1e 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window1.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window1.java
@@ -35,7 +35,6 @@ import org.openoffice.xmerge.util.Debug;
 import org.openoffice.xmerge.util.EndianConverter;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
 
-
 /**
  * Represents a BIFF REcord that describes workbook window attributes
  */
@@ -91,7 +90,7 @@ public class Window1 implements BIFFRecord {
        /**
       * Reads a Window1 Record from an <code>InputStream</code>
       *
-      * @param  is InputStream containing a Window1 Record
+      * @param  input InputStream containing a Window1 Record
       */
     public int read(InputStream input) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window2.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window2.java
index 4c49a941219c..12bc74641092 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window2.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Window2.java
@@ -37,7 +37,6 @@ import org.openoffice.xmerge.util.EndianConverter;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
 import org.openoffice.xmerge.converter.xml.sxc.SheetSettings;
 
-
 /**
  * Represents a BIFF Record that describes worksheet window attributes
  */
@@ -127,7 +126,7 @@ public class Window2 implements BIFFRecord {
        /**
       * Reads a Window2 Record from an <code>InputStream</code>
       *
-      * @param  is InputStream containing a Window2 Record
+      * @param  input InputStream containing a Window2 Record
       */
     public int read(InputStream input) throws IOException {
 
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java
index 5a9f329e4667..2fb8f416c037 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Workbook.java
@@ -69,7 +69,6 @@ OfficeConstants {
         eof             = new Eof();
     }
 
-
     /**
      * Constructs a pocket Excel Workbook with the name of the file passed in
      * as an argument. Also fills out a basic header block containing the
@@ -91,7 +90,9 @@ OfficeConstants {
      * Constructs a pocket Excel Workbook from the
      * <code>InputStream</code> and assigns it the document name passed in
      *
-     * @param   is InputStream containing a Pocket Excel Data file.
+     * @param   name Name of the Pocket Excel Data file. (including the file
+     *               extension)
+     * @param   is   InputStream containing a Pocket Excel Data file.
      */
     public Workbook(String name, InputStream is) throws IOException {
         read(is);
@@ -240,7 +241,7 @@ OfficeConstants {
     /**
       * Adds a ExtendedFormat record to the workbook
      *
-      * @param  f the font recrod to add
+      * @param  fmt the font record to add
       */
     public int addExtendedFormat(Format fmt) throws IOException {
 
@@ -362,7 +363,7 @@ OfficeConstants {
     /**
      * Adds a <code>Worksheet</code> to the workbook.
      *
-     * @return name the name of the <code>Worksheet</code> to be added
+     * @param name the name of the <code>Worksheet</code> to be added
      */
     public void addWorksheet(String name) throws IOException {
 
@@ -376,7 +377,10 @@ OfficeConstants {
     /**
      * Adds a cell to the current worksheet.
      *
-     * @return the name of the <code>Worksheet</code> to be added
+     * @param row          Row index for the new cell.
+     * @param col          Column index for the new cell.
+     * @param fmt          Format description for the new cell.
+     * @param cellContents Contents for the new cell.
      */
     public void addCell(int row,int col, Format fmt, String cellContents)
     throws IOException {
@@ -429,7 +433,7 @@ OfficeConstants {
 
     /**
       * Will create a number of ColInfo records based on the column widths
-     * based in.
+     * passed in.
      *
       * @param  columnRows <code>Vector</code> of <code>ColumnRowInfo</code>
       */
@@ -470,12 +474,11 @@ OfficeConstants {
         }
     }
 
-    /**
-      * Will create a number of ColInfo recrods based on the column widths
-     * based in.
-     *
-      * @param  an integer list representing the column widths
-      */
+   /**
+    * Add a name definition to the workbook.
+    *
+    * @param nameDefinition The name definition to add.
+    */
     public void addNameDefinition(NameDefinition nameDefinition) throws IOException {
 
         DefinedName dn = new DefinedName(nameDefinition, this);
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java
index 6ab57189f39f..7c43122cef76 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/Worksheet.java
@@ -38,7 +38,6 @@ import org.openoffice.xmerge.util.Debug;
 import org.openoffice.xmerge.converter.xml.sxc.SheetSettings;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.PocketExcelConstants;
 
-
 /**
  *  This class is used by <code>PxlDocument</code> to maintain pexcel
  *  worksheets.
@@ -61,18 +60,16 @@ public class Worksheet {
     private Eof eof;
 
     /**
-      * Writes the current workbook to the <code>Outputstream</code>
+      * Creates a worksheet in a given workbook.
       *
-      * @param  os The destination outputstream
+      * @param  wb The destination workbook.
       */
     public Worksheet(Workbook wb) {
         this.wb = wb;
     }
 
     /**
-      * Default Contructor
-      *
-      * @param  os The destination outputstream
+      * Default Contructor. Creates a worksheet not attached to any workbook.
       */
     public Worksheet() {
     }
@@ -108,11 +105,12 @@ public class Worksheet {
     }
 
     /**
-      * Reads a worksheet from the <code>InputStream</code> and contructs a
+     *  Reads a worksheet from the <code>InputStream</code> and contructs a
      *  workbook object from it
      *
-      * @param  is InputStream containing a Pocket Excel Data file.
-      */
+     * @param   is InputStream containing a Pocket Excel Data file.
+     * @return True if we read anything. False if not.
+     */
     public boolean read(InputStream is) throws IOException {
 
         int b = is.read();
@@ -230,38 +228,38 @@ public class Worksheet {
     }
 
     /**
-      * Adds a cell to this worksheet. Current valdid celltypes are
-     * <code>FloatNumber</code>, <code>LabelCell</code> or <code>Formula</code>
+     * Adds a cell to this worksheet based on a <code>BIFFRecord</code>.
+     * Current valdid celltypes are <code>FloatNumber</code>,
+     * <code>LabelCell</code> or <code>Formula</code>
      *
-      * @param  f the font recrod to add
-      */
+     * @param br The <code>BIFFRecord</code> to read from.
+     */
     public void addCell(BIFFRecord br) {
         cells.add(br);
     }
 
     /**
-      * Adds a number of ColInfo Records to the worksheet base on a list of
-     * clumnwidths passed in
+     * Adds a row to the worksheet.
      *
-      * @param  list of column widths
-      */
+     * @param r The row to add.
+     */
     public void addRow(Row r) {
         rows.add(r);
     }
 
     /**
-      * Adds a number of ColInfo Records to the worksheet base on a list of
-     * clumnwidths passed in
+     * Adds a ColInfo record to the worksheet. This may effec more than one column.
      *
-      * @param  list of column widths
-      */
+     * @param c ColInfo structure defining widths, format etc.
+     */
     public void addCol(ColInfo c) {
         colInfo.add(c);
     }
+
     /**
-     * Returns an <code>Enumeration</code> to the ColInfo's for this worksheet
+     * Add various settings to this worksheet.
      *
-     * @return an <code>Enumeration</code> to the ColInfo's
+     * @param s SheetSettings object defining pane number, splits etc.
      */
     public void addSettings(SheetSettings s) {