Java update - fix various javadoc issues

Along the way, remove some javadoc comments that are completely incorrect.

Change-Id: I02f96b6cbe665d2c10bd6ee245a7d8e2eef0f755

6 files changed, 8 insertions, 26 deletions

diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelDecoder.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelDecoder.java
index 219670fdfedc..a69433833c1e 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelDecoder.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelDecoder.java
@@ -45,8 +45,7 @@ import org.openoffice.xmerge.converter.xml.sxc.pexcel.records.Worksheet;
 import org.openoffice.xmerge.util.Debug;
 
 /**
- *  This class is used by {@link
- *  org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializerImpl}
+ *  This class is used by {@link SxcDocumentDeserializerImpl}
  *  SxcDocumentDeserializerImpl} to decode the Pocket Excel format.
  *
  *  @author   Paul Rank
@@ -84,7 +83,7 @@ final class PocketExcelDecoder extends SpreadsheetDecoder {
      *  converts it into a PocketWord WorkSheet.  The WorkSheet is then
      *  added to the WorkBook.
      *
-     *  @param  InputStream An <code>ConvertData</code> containing a
+     *  @param  cd An <code>ConvertData</code> containing a
      *                      Pocket Excel WorkSheet.
      *
      *  @throws  IOException  If any I/O error occurs.
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelEncoder.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelEncoder.java
index a7b64d94bd2e..ce5779cf1e75 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelEncoder.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelEncoder.java
@@ -31,9 +31,7 @@ import org.openoffice.xmerge.converter.xml.sxc.NameDefinition;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.records.Workbook;
 
 /**
- *  This class is used by {@link
- *  org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializerImpl
- * SxcDocumentSerializerImpl} to encode the Pocket Excel format.
+ *  This class is used by {@link SxcDocumentSerializerImpl} to encode the Pocket Excel format.
  *
  *  @author  Martin Maher
  */
@@ -200,20 +198,13 @@ final class PocketExcelEncoder extends SpreadsheetEncoder {
     /**
      *  Set the width of the columns in the WorkBook.
      *
-     *  @param  columnWidths  An <code>IntArrayList</code> of column
-     *                        widths.
+     *  @param  columnRows  An <code>ArrayList</code> of ColumnRowInfo
      */
     public void setColumnRows(ArrayList<ColumnRowInfo> columnRows) throws IOException {
 
         wb.addColInfo(columnRows);
     }
 
-     /**
-     *  Set the width of the columns in the WorkBook.
-     *
-     *  @param  columnWidths  An <code>IntArrayList</code> of column
-     *                        widths.
-     */
     public void setNameDefinition(NameDefinition nd) throws IOException {
 
         String parsedName = nd.getDefinition();
@@ -222,12 +213,6 @@ final class PocketExcelEncoder extends SpreadsheetEncoder {
         wb.addNameDefinition(nd);
     }
 
-     /**
-     *  Set the width of the columns in the WorkBook.
-     *
-     *  @param  columnWidths  An <code>IntArrayList</code> of column
-     *                        widths.
-     */
     public void addSettings(BookSettings s) throws IOException {
 
         wb.addSettings(s);
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 d9401c27e0b5..51ac357973f0 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
@@ -59,7 +59,7 @@ public class BoundSheet implements BIFFRecord {
       * Sets the worksheet name. The sheetname length must be doubled as the
      * String is stored in unicode format.
       *
-      * @param  sheetname   worksheet name
+      * @param  sheetName   worksheet name
       */
     void setSheetName(String sheetName) throws IOException {
         this.cch        = (byte) sheetName.length();
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 d0422ebb5745..7c88383e9c48 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
@@ -118,8 +118,6 @@ public class LabelCell extends CellValue {
 
     /**
      * Sets the <code>String</code> representing the cells contents
-     *
-     * @return the <code>String</code> representing the cells contents
      */
     private void setLabel(String cellContents) throws IOException {
         rgch = cellContents.getBytes("UTF-16LE");
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaParser.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaParser.java
index 9dd327354078..db7c8e59d180 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaParser.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/FormulaParser.java
@@ -128,7 +128,7 @@ public class FormulaParser {
     /**
      * Identify <, >, <=, >=, =, <>
      *
-     * @param  The <code>String</code> which is to be identified
+     * @param  op The <code>String</code> which is to be identified
      * @return A boolean returning the result of the comparison
      */
     private boolean isLogicalOp(String op) {
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/TokenEncoder.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/TokenEncoder.java
index d597b2292dbb..2d26654d0a2c 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/TokenEncoder.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/records/formula/TokenEncoder.java
@@ -279,7 +279,7 @@ public class TokenEncoder {
     /**
      * A Cell Reference Encoder (It supports absolute and relative addressing)
      *
-     * @param t <code>Token</code> to be encoded
+     * @param cellCoordinates <code>Token</code> to be encoded
      * @return A <code>Vector</code> of pexcel <code>Byte</code>
      */
     private byte[] encodeCellCoordinates(String cellCoordinates) {
@@ -362,7 +362,7 @@ public class TokenEncoder {
     /**
      * This function will find the sheetname index for a given String
      *
-     * @param t <code>Token</code> to be encoded
+     * @param s <code>Token</code> to be encoded
      * @return A <code>Vector</code> of pexcel <code>Byte</code>
      */
     private short findSheetIndex(String s) {