From f6a62d9e4106f36aff899c847d63e3198532796e Mon Sep 17 00:00:00 2001 From: Noel Grandin Date: Mon, 20 Aug 2012 12:54:24 +0100 Subject: Java update - fix various javadoc issues Along the way, remove some javadoc comments that are completely incorrect. Change-Id: I02f96b6cbe665d2c10bd6ee245a7d8e2eef0f755 --- .../converter/xml/sxc/pexcel/PocketExcelDecoder.java | 5 ++--- .../converter/xml/sxc/pexcel/PocketExcelEncoder.java | 19 ++----------------- .../converter/xml/sxc/pexcel/records/BoundSheet.java | 2 +- .../converter/xml/sxc/pexcel/records/LabelCell.java | 2 -- .../xml/sxc/pexcel/records/formula/FormulaParser.java | 2 +- .../xml/sxc/pexcel/records/formula/TokenEncoder.java | 4 ++-- 6 files changed, 8 insertions(+), 26 deletions(-) (limited to 'xmerge/source/pexcel/java/org') 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 ConvertData containing a + * @param cd An ConvertData 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 IntArrayList of column - * widths. + * @param columnRows An ArrayList of ColumnRowInfo */ public void setColumnRows(ArrayList columnRows) throws IOException { wb.addColInfo(columnRows); } - /** - * Set the width of the columns in the WorkBook. - * - * @param columnWidths An IntArrayList 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 IntArrayList 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 String representing the cells contents - * - * @return the String 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 String which is to be identified + * @param op The String 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 Token to be encoded + * @param cellCoordinates Token to be encoded * @return A Vector of pexcel Byte */ 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 Token to be encoded + * @param s Token to be encoded * @return A Vector of pexcel Byte */ private short findSheetIndex(String s) { -- cgit v1.2.3