From d3a5bd28f8303a16d064f0b508cabb6e74ffab0d Mon Sep 17 00:00:00 2001 From: Glen Stampoultzis Date: Mon, 11 Feb 2002 03:49:39 +0000 Subject: [PATCH] Javadoc fixes git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352084 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/poi/hssf/record/BOFRecord.java | 12 ++++++------ .../apache/poi/hssf/record/BackupRecord.java | 14 +++++++------- .../apache/poi/hssf/record/BeginRecord.java | 12 ++++++------ .../apache/poi/hssf/record/BlankRecord.java | 12 ++++++------ .../apache/poi/hssf/record/BookBoolRecord.java | 12 ++++++------ .../apache/poi/hssf/record/BoolErrRecord.java | 18 +++++++++--------- .../poi/hssf/record/BoundSheetRecord.java | 12 ++++++------ .../poi/hssf/record/CalcCountRecord.java | 12 ++++++------ .../apache/poi/hssf/record/CalcModeRecord.java | 12 ++++++------ .../poi/hssf/record/ChartFormatRecord.java | 8 ++++---- .../apache/poi/hssf/record/ChartRecord.java | 12 ++++++------ .../apache/poi/hssf/record/CodepageRecord.java | 12 ++++++------ .../poi/hssf/record/ColumnInfoRecord.java | 12 ++++++------ .../apache/poi/hssf/record/CountryRecord.java | 12 ++++++------ .../apache/poi/hssf/record/DBCellRecord.java | 12 ++++++------ .../org/apache/poi/hssf/record/DSFRecord.java | 12 ++++++------ .../poi/hssf/record/DateWindow1904Record.java | 12 ++++++------ .../poi/hssf/record/DefaultColWidthRecord.java | 12 ++++++------ .../hssf/record/DefaultRowHeightRecord.java | 14 +++++++------- .../apache/poi/hssf/record/DeltaRecord.java | 12 ++++++------ .../poi/hssf/record/DimensionsRecord.java | 14 +++++++------- .../org/apache/poi/hssf/record/EOFRecord.java | 12 ++++++------ .../org/apache/poi/hssf/record/EndRecord.java | 12 ++++++------ .../apache/poi/hssf/record/ExtSSTRecord.java | 12 ++++++------ .../poi/hssf/record/ExtendedFormatRecord.java | 12 ++++++------ .../poi/hssf/record/FnGroupCountRecord.java | 12 ++++++------ .../org/apache/poi/hssf/record/FontRecord.java | 12 ++++++------ .../apache/poi/hssf/record/FooterRecord.java | 12 ++++++------ .../apache/poi/hssf/record/FormatRecord.java | 12 ++++++------ .../apache/poi/hssf/record/FormulaRecord.java | 12 ++++++------ .../apache/poi/hssf/record/GridsetRecord.java | 12 ++++++------ .../org/apache/poi/hssf/record/GutsRecord.java | 12 ++++++------ .../apache/poi/hssf/record/HCenterRecord.java | 12 ++++++------ .../apache/poi/hssf/record/HeaderRecord.java | 12 ++++++------ .../apache/poi/hssf/record/HideObjRecord.java | 12 ++++++------ .../apache/poi/hssf/record/IndexRecord.java | 12 ++++++------ .../poi/hssf/record/InterfaceEndRecord.java | 12 ++++++------ .../poi/hssf/record/InterfaceHdrRecord.java | 12 ++++++------ .../poi/hssf/record/IterationRecord.java | 12 ++++++------ .../apache/poi/hssf/record/LabelRecord.java | 12 ++++++------ .../apache/poi/hssf/record/LabelSSTRecord.java | 12 ++++++------ .../org/apache/poi/hssf/record/MMSRecord.java | 12 ++++++------ .../poi/hssf/record/MergeCellsRecord.java | 12 ++++++------ .../apache/poi/hssf/record/MulBlankRecord.java | 12 ++++++------ .../apache/poi/hssf/record/MulRKRecord.java | 12 ++++++------ .../apache/poi/hssf/record/NumberRecord.java | 12 ++++++------ .../apache/poi/hssf/record/PasswordRecord.java | 12 ++++++------ .../poi/hssf/record/PasswordRev4Record.java | 12 ++++++------ .../poi/hssf/record/PrecisionRecord.java | 12 ++++++------ .../poi/hssf/record/PrintGridlinesRecord.java | 12 ++++++------ .../poi/hssf/record/PrintHeadersRecord.java | 12 ++++++------ .../poi/hssf/record/PrintSetupRecord.java | 12 ++++++------ .../poi/hssf/record/ProtectionRev4Record.java | 12 ++++++------ .../org/apache/poi/hssf/record/RKRecord.java | 12 ++++++------ .../apache/poi/hssf/record/RefModeRecord.java | 12 ++++++------ .../poi/hssf/record/RefreshAllRecord.java | 12 ++++++------ .../org/apache/poi/hssf/record/RowRecord.java | 12 ++++++------ .../poi/hssf/record/SaveRecalcRecord.java | 12 ++++++------ .../poi/hssf/record/SelectionRecord.java | 12 ++++++------ .../apache/poi/hssf/record/StyleRecord.java | 12 ++++++------ .../apache/poi/hssf/record/TabIdRecord.java | 12 ++++++------ .../apache/poi/hssf/record/UseSelFSRecord.java | 12 ++++++------ .../apache/poi/hssf/record/VCenterRecord.java | 12 ++++++------ .../apache/poi/hssf/record/WSBoolRecord.java | 12 ++++++------ .../poi/hssf/record/WindowOneRecord.java | 12 ++++++------ .../poi/hssf/record/WindowProtectRecord.java | 12 ++++++------ .../poi/hssf/record/WindowTwoRecord.java | 12 ++++++------ .../poi/hssf/record/WriteAccessRecord.java | 12 ++++++------ 68 files changed, 412 insertions(+), 412 deletions(-) diff --git a/src/java/org/apache/poi/hssf/record/BOFRecord.java b/src/java/org/apache/poi/hssf/record/BOFRecord.java index d48e37ca49..b98e697fab 100644 --- a/src/java/org/apache/poi/hssf/record/BOFRecord.java +++ b/src/java/org/apache/poi/hssf/record/BOFRecord.java @@ -124,9 +124,9 @@ public class BOFRecord /** * Constructs a BOFRecord and sets its fields appropriately * - * @param short id must be 0x809 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x809 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) */ public BOFRecord(short id, short size, byte [] data) @@ -139,9 +139,9 @@ public class BOFRecord /** * Constructs a BOFRecord and sets its fields appropriately * - * @param short id must be 0x809 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x809 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 offset the offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/BackupRecord.java b/src/java/org/apache/poi/hssf/record/BackupRecord.java index 42d1e74d27..ef2e7beb6d 100644 --- a/src/java/org/apache/poi/hssf/record/BackupRecord.java +++ b/src/java/org/apache/poi/hssf/record/BackupRecord.java @@ -79,9 +79,9 @@ public class BackupRecord /** * Constructs a BackupRecord and sets its fields appropriately * - * @param short id must be 0x40 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x40 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) */ public BackupRecord(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class BackupRecord /** * Constructs a BackupRecord and sets its fields appropriately * - * @param short id must be 0x40 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x40 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 offset of the start of the record's data */ @@ -119,7 +119,7 @@ public class BackupRecord /** * set the backup flag (0,1) * - * @param short backup flag + * @param backup backup flag */ public void setBackup(short backup) diff --git a/src/java/org/apache/poi/hssf/record/BeginRecord.java b/src/java/org/apache/poi/hssf/record/BeginRecord.java index ff2d82ee52..ec27b9c374 100644 --- a/src/java/org/apache/poi/hssf/record/BeginRecord.java +++ b/src/java/org/apache/poi/hssf/record/BeginRecord.java @@ -78,9 +78,9 @@ public class BeginRecord /** * Constructs a BeginRecord record and sets its fields appropriately. * - * @param short id must be 0x1033 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1033 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) */ public BeginRecord(short id, short size, byte [] data) @@ -91,9 +91,9 @@ public class BeginRecord /** * Constructs a BeginRecord record and sets its fields appropriately. * - * @param short id must be 0x1033 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1033 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/BlankRecord.java b/src/java/org/apache/poi/hssf/record/BlankRecord.java index f01f95c820..ea50a4dd8c 100644 --- a/src/java/org/apache/poi/hssf/record/BlankRecord.java +++ b/src/java/org/apache/poi/hssf/record/BlankRecord.java @@ -88,9 +88,9 @@ public class BlankRecord /** * Constructs a BlankRecord and sets its fields appropriately * - * @param short id must be 0x201 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x201 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) */ public BlankRecord(short id, short size, byte [] data) @@ -101,9 +101,9 @@ public class BlankRecord /** * Constructs a BlankRecord and sets its fields appropriately * - * @param short id must be 0x201 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x201 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/BookBoolRecord.java b/src/java/org/apache/poi/hssf/record/BookBoolRecord.java index df273d5c7a..1f6f3a5002 100644 --- a/src/java/org/apache/poi/hssf/record/BookBoolRecord.java +++ b/src/java/org/apache/poi/hssf/record/BookBoolRecord.java @@ -79,9 +79,9 @@ public class BookBoolRecord /** * Constructs a BookBoolRecord and sets its fields appropriately * - * @param short id must be 0xDA or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xDA 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) */ public BookBoolRecord(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class BookBoolRecord /** * Constructs a BookBoolRecord and sets its fields appropriately * - * @param short id must be 0xDA or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xDA 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/BoolErrRecord.java b/src/java/org/apache/poi/hssf/record/BoolErrRecord.java index 9777c29f4d..26dbc77ef2 100644 --- a/src/java/org/apache/poi/hssf/record/BoolErrRecord.java +++ b/src/java/org/apache/poi/hssf/record/BoolErrRecord.java @@ -89,9 +89,9 @@ public class BoolErrRecord /** * Constructs a BoolErr record and sets its fields appropriately. * - * @param short id must be 0x205 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x205 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) */ public BoolErrRecord(short id, short size, byte [] data) @@ -102,9 +102,9 @@ public class BoolErrRecord /** * Constructs a BoolErr record and sets its fields appropriately. * - * @param short id must be 0x205 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x205 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 offset of the record */ @@ -143,7 +143,7 @@ public class BoolErrRecord /** * set the index to the ExtendedFormat * @see org.apache.poi.hssf.record.ExtendedFormatRecord - * @param index to the XF record + * @param xf index to the XF record */ public void setXFIndex(short xf) @@ -154,7 +154,7 @@ public class BoolErrRecord /** * set the boolean value for the cell * - * @param boolean representing the boolean value + * @param value representing the boolean value */ public void setValue(boolean value) @@ -167,7 +167,7 @@ public class BoolErrRecord /** * set the error value for the cell * - * @param error representing the error value + * @param value error representing the error value */ public void setValue(byte value) diff --git a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java index d6228cd3a5..a2b7739d6b 100644 --- a/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java +++ b/src/java/org/apache/poi/hssf/record/BoundSheetRecord.java @@ -85,9 +85,9 @@ public class BoundSheetRecord /** * Constructs a BoundSheetRecord and sets its fields appropriately * - * @param short id must be 0x85 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x85 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) */ public BoundSheetRecord(short id, short size, byte [] data) @@ -98,9 +98,9 @@ public class BoundSheetRecord /** * Constructs a BoundSheetRecord and sets its fields appropriately * - * @param short id must be 0x85 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x85 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/CalcCountRecord.java b/src/java/org/apache/poi/hssf/record/CalcCountRecord.java index 7b4fcc813b..bee2522a02 100644 --- a/src/java/org/apache/poi/hssf/record/CalcCountRecord.java +++ b/src/java/org/apache/poi/hssf/record/CalcCountRecord.java @@ -83,9 +83,9 @@ public class CalcCountRecord /** * Constructs a CalcCountRecord and sets its fields appropriately * - * @param short id must be 0xC or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xC 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) * */ @@ -97,9 +97,9 @@ public class CalcCountRecord /** * Constructs a CalcCountRecord and sets its fields appropriately * - * @param short id must be 0xC or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xC 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/CalcModeRecord.java b/src/java/org/apache/poi/hssf/record/CalcModeRecord.java index c2ec3be5eb..46ab942318 100644 --- a/src/java/org/apache/poi/hssf/record/CalcModeRecord.java +++ b/src/java/org/apache/poi/hssf/record/CalcModeRecord.java @@ -99,9 +99,9 @@ public class CalcModeRecord /** * Constructs a CalcModeRecord and sets its fields appropriately * - * @param short id must be 0xD or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xD 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) */ public CalcModeRecord(short id, short size, byte [] data) @@ -112,9 +112,9 @@ public class CalcModeRecord /** * Constructs a CalcModeRecord and sets its fields appropriately * - * @param short id must be 0xD or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xD 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 offset of the record's start data */ diff --git a/src/java/org/apache/poi/hssf/record/ChartFormatRecord.java b/src/java/org/apache/poi/hssf/record/ChartFormatRecord.java index d86573418b..d0254a6a85 100644 --- a/src/java/org/apache/poi/hssf/record/ChartFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/ChartFormatRecord.java @@ -87,8 +87,8 @@ public class ChartFormatRecord * Constructs a ChartFormatRecord record and sets its fields appropriately. * * @param short id must equal the sid or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param size the size of the data area of the record + * @param data data of the record (should not contain sid/len) */ public ChartFormatRecord(short id, short size, byte [] data) @@ -100,8 +100,8 @@ public class ChartFormatRecord * Constructs a ChartFormatRecord record and sets its fields appropriately. * * @param short id must equal the sid or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param size the size of the data area of the record + * @param data data of the record (should not contain sid/len) * @param offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/ChartRecord.java b/src/java/org/apache/poi/hssf/record/ChartRecord.java index bc425b5284..30a8981cd8 100644 --- a/src/java/org/apache/poi/hssf/record/ChartRecord.java +++ b/src/java/org/apache/poi/hssf/record/ChartRecord.java @@ -84,9 +84,9 @@ public class ChartRecord /** * Constructs a ChartRecord record and sets its fields appropriately. * - * @param short id must be 0x1002 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1002 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) */ public ChartRecord(short id, short size, byte [] data) @@ -97,9 +97,9 @@ public class ChartRecord /** * Constructs a SeriesRecord record and sets its fields appropriately. * - * @param short id must be 0x1002 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1002 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/CodepageRecord.java b/src/java/org/apache/poi/hssf/record/CodepageRecord.java index 41ac712c33..a903dae243 100644 --- a/src/java/org/apache/poi/hssf/record/CodepageRecord.java +++ b/src/java/org/apache/poi/hssf/record/CodepageRecord.java @@ -86,9 +86,9 @@ public class CodepageRecord /** * Constructs a CodepageRecord and sets its fields appropriately * - * @param short id must be 0x42 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @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) */ public CodepageRecord(short id, short size, byte [] data) @@ -99,9 +99,9 @@ public class CodepageRecord /** * Constructs a CodepageRecord and sets its fields appropriately * - * @param short id must be 0x42 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @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 */ diff --git a/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java b/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java index f274a7574f..2e95e8a35a 100644 --- a/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java +++ b/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java @@ -92,9 +92,9 @@ public class ColumnInfoRecord /** * Constructs a ColumnInfo record and sets its fields appropriately * - * @param short id must be 0x7d or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x7d 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) */ public ColumnInfoRecord(short id, short size, byte [] data) @@ -105,9 +105,9 @@ public class ColumnInfoRecord /** * Constructs a ColumnInfo record and sets its fields appropriately * - * @param short id must be 0x7d or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x7d 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/CountryRecord.java b/src/java/org/apache/poi/hssf/record/CountryRecord.java index 184bf981e1..3e64cb3060 100644 --- a/src/java/org/apache/poi/hssf/record/CountryRecord.java +++ b/src/java/org/apache/poi/hssf/record/CountryRecord.java @@ -83,9 +83,9 @@ public class CountryRecord /** * Constructs a CountryRecord and sets its fields appropriately * - * @param short id must be 0x8c or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x8c 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) */ public CountryRecord(short id, short size, byte [] data) @@ -96,9 +96,9 @@ public class CountryRecord /** * Constructs a CountryRecord and sets its fields appropriately * - * @param short id must be 0x8c or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x8c 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/DBCellRecord.java b/src/java/org/apache/poi/hssf/record/DBCellRecord.java index d267be248f..a536c7d8b5 100644 --- a/src/java/org/apache/poi/hssf/record/DBCellRecord.java +++ b/src/java/org/apache/poi/hssf/record/DBCellRecord.java @@ -81,9 +81,9 @@ public class DBCellRecord /** * Constructs a DBCellRecord and sets its fields appropriately * - * @param short id must be 0xd7 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xd7 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) */ public DBCellRecord(short id, short size, byte [] data) @@ -94,9 +94,9 @@ public class DBCellRecord /** * Constructs a DBCellRecord and sets its fields appropriately * - * @param short id must be 0xd7 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xd7 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/DSFRecord.java b/src/java/org/apache/poi/hssf/record/DSFRecord.java index 5f7048ee68..ed14de1795 100644 --- a/src/java/org/apache/poi/hssf/record/DSFRecord.java +++ b/src/java/org/apache/poi/hssf/record/DSFRecord.java @@ -79,9 +79,9 @@ public class DSFRecord /** * Constructs a DBCellRecord and sets its fields appropriately. * - * @param short id must be 0x161 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x161 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) */ public DSFRecord(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class DSFRecord /** * Constructs a DBCellRecord and sets its fields appropriately. * - * @param short id must be 0x161 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x161 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/DateWindow1904Record.java b/src/java/org/apache/poi/hssf/record/DateWindow1904Record.java index 14f43bf344..bded07ea57 100644 --- a/src/java/org/apache/poi/hssf/record/DateWindow1904Record.java +++ b/src/java/org/apache/poi/hssf/record/DateWindow1904Record.java @@ -79,9 +79,9 @@ public class DateWindow1904Record /** * Constructs a DateWindow1904 record and sets its fields appropriately. * - * @param short id must be 0x22 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x22 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) */ public DateWindow1904Record(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class DateWindow1904Record /** * Constructs a DateWindow1904 record and sets its fields appropriately. * - * @param short id must be 0x22 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x22 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/DefaultColWidthRecord.java b/src/java/org/apache/poi/hssf/record/DefaultColWidthRecord.java index 33fd6ceab5..221ca52ecb 100644 --- a/src/java/org/apache/poi/hssf/record/DefaultColWidthRecord.java +++ b/src/java/org/apache/poi/hssf/record/DefaultColWidthRecord.java @@ -79,9 +79,9 @@ public class DefaultColWidthRecord /** * Constructs a DefaultColumnWidth record and sets its fields appropriately. * - * @param short id must be 0x55 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x55 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) */ public DefaultColWidthRecord(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class DefaultColWidthRecord /** * Constructs a DefaultColumnWidth record and sets its fields appropriately. * - * @param short id must be 0x55 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x55 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/DefaultRowHeightRecord.java b/src/java/org/apache/poi/hssf/record/DefaultRowHeightRecord.java index b4088e4cdb..4486373f41 100644 --- a/src/java/org/apache/poi/hssf/record/DefaultRowHeightRecord.java +++ b/src/java/org/apache/poi/hssf/record/DefaultRowHeightRecord.java @@ -80,9 +80,9 @@ public class DefaultRowHeightRecord /** * Constructs a DefaultRowHeight record and sets its fields appropriately. * - * @param short id must be 0x225 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x225 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) */ public DefaultRowHeightRecord(short id, short size, byte [] data) @@ -93,9 +93,9 @@ public class DefaultRowHeightRecord /** * Constructs a DefaultRowHeight record and sets its fields appropriately. * - * @param short id must be 0x225 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x225 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 offset of the records data */ @@ -131,7 +131,7 @@ public class DefaultRowHeightRecord /** * set the default row height - * @param rowheight for undefined rows/rows w/undefined height + * @param height for undefined rows/rows w/undefined height */ public void setRowHeight(short height) diff --git a/src/java/org/apache/poi/hssf/record/DeltaRecord.java b/src/java/org/apache/poi/hssf/record/DeltaRecord.java index b54ecda5b0..ee5d52e443 100644 --- a/src/java/org/apache/poi/hssf/record/DeltaRecord.java +++ b/src/java/org/apache/poi/hssf/record/DeltaRecord.java @@ -82,9 +82,9 @@ public class DeltaRecord /** * Constructs a Delta record and sets its fields appropriately. * - * @param short id must be 0x10 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x10 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) */ public DeltaRecord(short id, short size, byte [] data) @@ -95,9 +95,9 @@ public class DeltaRecord /** * Constructs a Delta record and sets its fields appropriately. * - * @param short id must be 0x10 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x10 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 offset of record data */ diff --git a/src/java/org/apache/poi/hssf/record/DimensionsRecord.java b/src/java/org/apache/poi/hssf/record/DimensionsRecord.java index f1ccba5aea..93674a7d65 100644 --- a/src/java/org/apache/poi/hssf/record/DimensionsRecord.java +++ b/src/java/org/apache/poi/hssf/record/DimensionsRecord.java @@ -83,9 +83,9 @@ public class DimensionsRecord /** * Constructs a Dimensions record and sets its fields appropriately. * - * @param short id must be 0x200 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x200 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) */ public DimensionsRecord(short id, short size, byte [] data) @@ -96,9 +96,9 @@ public class DimensionsRecord /** * Constructs a Dimensions record and sets its fields appropriately. * - * @param short id must be 0x200 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x200 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 offset of the record's data */ @@ -146,7 +146,7 @@ public class DimensionsRecord /** * set the first column number for the sheet - * @param column - first column on the sheet + * @param col first column on the sheet */ public void setFirstCol(short col) diff --git a/src/java/org/apache/poi/hssf/record/EOFRecord.java b/src/java/org/apache/poi/hssf/record/EOFRecord.java index 294422a185..80ea80c954 100644 --- a/src/java/org/apache/poi/hssf/record/EOFRecord.java +++ b/src/java/org/apache/poi/hssf/record/EOFRecord.java @@ -79,9 +79,9 @@ public class EOFRecord /** * Constructs a EOFRecord record and sets its fields appropriately. * - * @param short id must be 0x0A or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x0A 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) */ public EOFRecord(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class EOFRecord /** * Constructs a EOFRecord record and sets its fields appropriately. * - * @param short id must be 0x0A or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x0A 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/EndRecord.java b/src/java/org/apache/poi/hssf/record/EndRecord.java index c6615e4de9..fba75ef9a9 100644 --- a/src/java/org/apache/poi/hssf/record/EndRecord.java +++ b/src/java/org/apache/poi/hssf/record/EndRecord.java @@ -78,9 +78,9 @@ public class EndRecord /** * Constructs a EndRecord record and sets its fields appropriately. * - * @param short id must be 0x1034 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1034 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) */ public EndRecord(short id, short size, byte [] data) @@ -91,9 +91,9 @@ public class EndRecord /** * Constructs a EndRecord record and sets its fields appropriately. * - * @param short id must be 0x1034 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1034 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java b/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java index 2221e6fab1..b102236f2a 100644 --- a/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExtSSTRecord.java @@ -87,9 +87,9 @@ public class ExtSSTRecord /** * Constructs a EOFRecord record and sets its fields appropriately. * - * @param short id must be 0xff or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xff 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) */ public ExtSSTRecord(short id, short size, byte [] data) @@ -100,9 +100,9 @@ public class ExtSSTRecord /** * Constructs a EOFRecord record and sets its fields appropriately. * - * @param short id must be 0xff or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xff 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java b/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java index 0d2fb0711f..6a586dcda4 100644 --- a/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java @@ -214,9 +214,9 @@ public class ExtendedFormatRecord /** * Constructs an ExtendedFormat record and sets its fields appropriately. * - * @param short id must be 0xE0 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xE0 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) */ public ExtendedFormatRecord(short id, short size, byte [] data) @@ -227,9 +227,9 @@ public class ExtendedFormatRecord /** * Constructs an ExtendedFormat record and sets its fields appropriately. * - * @param short id must be 0xE0 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xE0 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/FnGroupCountRecord.java b/src/java/org/apache/poi/hssf/record/FnGroupCountRecord.java index 069df5544a..249489d408 100644 --- a/src/java/org/apache/poi/hssf/record/FnGroupCountRecord.java +++ b/src/java/org/apache/poi/hssf/record/FnGroupCountRecord.java @@ -85,9 +85,9 @@ public class FnGroupCountRecord /** * Constructs a FnGroupCount record and sets its fields appropriately. * - * @param short id must be 0x9c or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x9c 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) */ public FnGroupCountRecord(short id, short size, byte [] data) @@ -98,9 +98,9 @@ public class FnGroupCountRecord /** * Constructs a FnGroupCount record and sets its fields appropriately. * - * @param short id must be 0x9c or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x9c 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/FontRecord.java b/src/java/org/apache/poi/hssf/record/FontRecord.java index 9996a8be5f..3b46985145 100644 --- a/src/java/org/apache/poi/hssf/record/FontRecord.java +++ b/src/java/org/apache/poi/hssf/record/FontRecord.java @@ -114,10 +114,10 @@ public class FontRecord /** * Constructs a Font record and sets its fields appropriately. * - * @param short id must be 0x31 (NOT 0x231 see MSKB #Q184647 for an "explanation of + * @param id id must be 0x31 (NOT 0x231 see MSKB #Q184647 for an "explanation of * this bug in the documentation) or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param size the size of the data area of the record + * @param data data of the record (should not contain sid/len) */ public FontRecord(short id, short size, byte [] data) @@ -128,10 +128,10 @@ public class FontRecord /** * Constructs a Font record and sets its fields appropriately. * - * @param short id must be 0x31 (NOT 0x231 see MSKB #Q184647 for an "explanation of + * @param id id must be 0x31 (NOT 0x231 see MSKB #Q184647 for an "explanation of * this bug in the documentation) or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param size the size of the data area of the record + * @param data data of the record (should not contain sid/len) * @param offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/FooterRecord.java b/src/java/org/apache/poi/hssf/record/FooterRecord.java index 20e8aff771..e6797eb4de 100644 --- a/src/java/org/apache/poi/hssf/record/FooterRecord.java +++ b/src/java/org/apache/poi/hssf/record/FooterRecord.java @@ -80,9 +80,9 @@ public class FooterRecord /** * Constructs a FooterRecord record and sets its fields appropriately. * - * @param short id must be 0x15 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x15 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) */ public FooterRecord(short id, short size, byte [] data) @@ -93,9 +93,9 @@ public class FooterRecord /** * Constructs a FooterRecord record and sets its fields appropriately. * - * @param short id must be 0x15 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x15 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/FormatRecord.java b/src/java/org/apache/poi/hssf/record/FormatRecord.java index d42177d45f..36b79ddbff 100644 --- a/src/java/org/apache/poi/hssf/record/FormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/FormatRecord.java @@ -83,9 +83,9 @@ public class FormatRecord /** * Constructs a Format record and sets its fields appropriately. * - * @param short id must be 0x41e or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x41e 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) */ public FormatRecord(short id, short size, byte [] data) @@ -96,9 +96,9 @@ public class FormatRecord /** * Constructs a Format record and sets its fields appropriately. * - * @param short id must be 0x41e or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x41e 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/FormulaRecord.java b/src/java/org/apache/poi/hssf/record/FormulaRecord.java index 94470102da..47d7d1ac82 100644 --- a/src/java/org/apache/poi/hssf/record/FormulaRecord.java +++ b/src/java/org/apache/poi/hssf/record/FormulaRecord.java @@ -98,10 +98,10 @@ public class FormulaRecord /** * Constructs a Formula record and sets its fields appropriately. * - * @param short id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an "explanation of + * @param id id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an "explanation of * this bug in the documentation) or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param size the size of the data area of the record + * @param data data of the record (should not contain sid/len) */ public FormulaRecord(short id, short size, byte [] data) @@ -112,10 +112,10 @@ public class FormulaRecord /** * Constructs a Formula record and sets its fields appropriately. * - * @param short id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an "explanation of + * @param id id must be 0x06 (NOT 0x406 see MSKB #Q184647 for an "explanation of * this bug in the documentation) or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param size the size of the data area of the record + * @param data data of the record (should not contain sid/len) * @param offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/GridsetRecord.java b/src/java/org/apache/poi/hssf/record/GridsetRecord.java index da44634256..1cf42aa43c 100644 --- a/src/java/org/apache/poi/hssf/record/GridsetRecord.java +++ b/src/java/org/apache/poi/hssf/record/GridsetRecord.java @@ -82,9 +82,9 @@ public class GridsetRecord /** * Constructs a GridSet record and sets its fields appropriately. * - * @param short id must be 0x82 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x82 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) */ public GridsetRecord(short id, short size, byte [] data) @@ -95,9 +95,9 @@ public class GridsetRecord /** * Constructs a GridSet record and sets its fields appropriately. * - * @param short id must be 0x82 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x82 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/GutsRecord.java b/src/java/org/apache/poi/hssf/record/GutsRecord.java index eff89e9ca6..628488af36 100644 --- a/src/java/org/apache/poi/hssf/record/GutsRecord.java +++ b/src/java/org/apache/poi/hssf/record/GutsRecord.java @@ -81,9 +81,9 @@ public class GutsRecord /** * Constructs a Guts record and sets its fields appropriately. * - * @param short id must be 0x80 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x80 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) */ public GutsRecord(short id, short size, byte [] data) @@ -94,9 +94,9 @@ public class GutsRecord /** * Constructs a Guts record and sets its fields appropriately. * - * @param short id must be 0x80 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x80 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/HCenterRecord.java b/src/java/org/apache/poi/hssf/record/HCenterRecord.java index 446451c045..00c7a71308 100644 --- a/src/java/org/apache/poi/hssf/record/HCenterRecord.java +++ b/src/java/org/apache/poi/hssf/record/HCenterRecord.java @@ -78,9 +78,9 @@ public class HCenterRecord /** * Constructs an HCenter record and sets its fields appropriately. * - * @param short id must be 0x83 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x83 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) */ public HCenterRecord(short id, short size, byte [] data) @@ -91,9 +91,9 @@ public class HCenterRecord /** * Constructs an HCenter record and sets its fields appropriately. * - * @param short id must be 0x83 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x83 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/HeaderRecord.java b/src/java/org/apache/poi/hssf/record/HeaderRecord.java index 14a9127ba9..bb3060ca98 100644 --- a/src/java/org/apache/poi/hssf/record/HeaderRecord.java +++ b/src/java/org/apache/poi/hssf/record/HeaderRecord.java @@ -80,9 +80,9 @@ public class HeaderRecord /** * Constructs an Header record and sets its fields appropriately. * - * @param short id must be 0x14 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x14 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) */ public HeaderRecord(short id, short size, byte [] data) @@ -93,9 +93,9 @@ public class HeaderRecord /** * Constructs an Header record and sets its fields appropriately. * - * @param short id must be 0x14 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x14 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/HideObjRecord.java b/src/java/org/apache/poi/hssf/record/HideObjRecord.java index a5d7dcd484..5ba1c0cc9c 100644 --- a/src/java/org/apache/poi/hssf/record/HideObjRecord.java +++ b/src/java/org/apache/poi/hssf/record/HideObjRecord.java @@ -81,9 +81,9 @@ public class HideObjRecord /** * Constructs an HideObj record and sets its fields appropriately. * - * @param short id must be 0x8d or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x8d 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) */ public HideObjRecord(short id, short size, byte [] data) @@ -94,9 +94,9 @@ public class HideObjRecord /** * Constructs an HideObj record and sets its fields appropriately. * - * @param short id must be 0x8d or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x8d 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/IndexRecord.java b/src/java/org/apache/poi/hssf/record/IndexRecord.java index 114eb8feed..a90a3bedc6 100644 --- a/src/java/org/apache/poi/hssf/record/IndexRecord.java +++ b/src/java/org/apache/poi/hssf/record/IndexRecord.java @@ -86,9 +86,9 @@ public class IndexRecord /** * Constructs an Index record and sets its fields appropriately. * - * @param short id must be 0x208 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x208 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) */ public IndexRecord(short id, short size, byte [] data) @@ -99,9 +99,9 @@ public class IndexRecord /** * Constructs an Index record and sets its fields appropriately. * - * @param short id must be 0x208 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x208 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 offset of record data */ diff --git a/src/java/org/apache/poi/hssf/record/InterfaceEndRecord.java b/src/java/org/apache/poi/hssf/record/InterfaceEndRecord.java index d8de449167..28c70b7799 100644 --- a/src/java/org/apache/poi/hssf/record/InterfaceEndRecord.java +++ b/src/java/org/apache/poi/hssf/record/InterfaceEndRecord.java @@ -78,9 +78,9 @@ public class InterfaceEndRecord /** * Constructs an InterfaceEnd record and sets its fields appropriately. * - * @param short id must be 0xe2 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xe2 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) */ public InterfaceEndRecord(short id, short size, byte [] data) @@ -91,9 +91,9 @@ public class InterfaceEndRecord /** * Constructs an InterfaceEnd record and sets its fields appropriately. * - * @param short id must be 0xe2 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xe2 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 offset of the data */ diff --git a/src/java/org/apache/poi/hssf/record/InterfaceHdrRecord.java b/src/java/org/apache/poi/hssf/record/InterfaceHdrRecord.java index af74935499..9d86b7edb4 100644 --- a/src/java/org/apache/poi/hssf/record/InterfaceHdrRecord.java +++ b/src/java/org/apache/poi/hssf/record/InterfaceHdrRecord.java @@ -84,9 +84,9 @@ public class InterfaceHdrRecord /** * Constructs an Codepage record and sets its fields appropriately. * - * @param short id must be 0xe1 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xe1 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) */ public InterfaceHdrRecord(short id, short size, byte [] data) @@ -97,9 +97,9 @@ public class InterfaceHdrRecord /** * Constructs an Codepage record and sets its fields appropriately. * - * @param short id must be 0xe1 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xe1 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/IterationRecord.java b/src/java/org/apache/poi/hssf/record/IterationRecord.java index ec0847a533..8e0717ebf8 100644 --- a/src/java/org/apache/poi/hssf/record/IterationRecord.java +++ b/src/java/org/apache/poi/hssf/record/IterationRecord.java @@ -81,9 +81,9 @@ public class IterationRecord /** * Constructs an Iteration record and sets its fields appropriately. * - * @param short id must be 0x11 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x11 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) */ public IterationRecord(short id, short size, byte [] data) @@ -94,9 +94,9 @@ public class IterationRecord /** * Constructs an Iteration record and sets its fields appropriately. * - * @param short id must be 0x11 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x11 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/LabelRecord.java b/src/java/org/apache/poi/hssf/record/LabelRecord.java index 5173851f69..429a063e47 100644 --- a/src/java/org/apache/poi/hssf/record/LabelRecord.java +++ b/src/java/org/apache/poi/hssf/record/LabelRecord.java @@ -93,9 +93,9 @@ public class LabelRecord /** * Constructs an Label record and sets its fields appropriately. * - * @param short id must be 0x204 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x204 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) */ public LabelRecord(short id, short size, byte [] data) @@ -106,9 +106,9 @@ public class LabelRecord /** * Constructs an Label record and sets its fields appropriately. * - * @param short id must be 0x204 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x204 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 offset of the record */ diff --git a/src/java/org/apache/poi/hssf/record/LabelSSTRecord.java b/src/java/org/apache/poi/hssf/record/LabelSSTRecord.java index 3cd1054877..c037af15d3 100644 --- a/src/java/org/apache/poi/hssf/record/LabelSSTRecord.java +++ b/src/java/org/apache/poi/hssf/record/LabelSSTRecord.java @@ -83,9 +83,9 @@ public class LabelSSTRecord /** * Constructs an LabelSST record and sets its fields appropriately. * - * @param short id must be 0xfd or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xfd 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) */ public LabelSSTRecord(short id, short size, byte [] data) @@ -96,9 +96,9 @@ public class LabelSSTRecord /** * Constructs an LabelSST record and sets its fields appropriately. * - * @param short id must be 0xfd or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xfd 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/MMSRecord.java b/src/java/org/apache/poi/hssf/record/MMSRecord.java index 7219620d32..efb06479f6 100644 --- a/src/java/org/apache/poi/hssf/record/MMSRecord.java +++ b/src/java/org/apache/poi/hssf/record/MMSRecord.java @@ -80,9 +80,9 @@ public class MMSRecord /** * Constructs a MMS record and sets its fields appropriately. * - * @param short id must be 0xc1 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xc1 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) */ public MMSRecord(short id, short size, byte [] data) @@ -93,9 +93,9 @@ public class MMSRecord /** * Constructs a MMS record and sets its fields appropriately. * - * @param short id must be 0xc1 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xc1 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 offset of the data */ diff --git a/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java b/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java index 9bfd98ec92..633c38315c 100644 --- a/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java +++ b/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java @@ -82,9 +82,9 @@ public class MergeCellsRecord /** * Constructs a MergedCellsRecord and sets its fields appropriately * - * @param short id must be 0xe5 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xe5 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) */ public MergeCellsRecord(short sid, short size, byte [] data) @@ -95,9 +95,9 @@ public class MergeCellsRecord /** * Constructs a MergedCellsRecord and sets its fields appropriately * - * @param short id must be 0xe5 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xe5 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 offset the offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/MulBlankRecord.java b/src/java/org/apache/poi/hssf/record/MulBlankRecord.java index 80562df004..cdfebd7860 100644 --- a/src/java/org/apache/poi/hssf/record/MulBlankRecord.java +++ b/src/java/org/apache/poi/hssf/record/MulBlankRecord.java @@ -92,9 +92,9 @@ public class MulBlankRecord /** * Constructs a MulBlank record and sets its fields appropriately. * - * @param short id must be 0xbe or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xbe 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) */ public MulBlankRecord(short id, short size, byte [] data) @@ -105,9 +105,9 @@ public class MulBlankRecord /** * Constructs a MulBlank record and sets its fields appropriately. * - * @param short id must be 0xbe or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xbe 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/MulRKRecord.java b/src/java/org/apache/poi/hssf/record/MulRKRecord.java index 715619586f..88a6096c6f 100644 --- a/src/java/org/apache/poi/hssf/record/MulRKRecord.java +++ b/src/java/org/apache/poi/hssf/record/MulRKRecord.java @@ -90,9 +90,9 @@ public class MulRKRecord /** * Constructs a MulRK record and sets its fields appropriately. * - * @param short id must be 0xbd or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xbd 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) */ public MulRKRecord(short id, short size, byte [] data) @@ -103,9 +103,9 @@ public class MulRKRecord /** * Constructs a MulRK record and sets its fields appropriately. * - * @param short id must be 0xbd or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xbd 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 offset of data */ diff --git a/src/java/org/apache/poi/hssf/record/NumberRecord.java b/src/java/org/apache/poi/hssf/record/NumberRecord.java index ddd1d29617..d1fe3f1f32 100644 --- a/src/java/org/apache/poi/hssf/record/NumberRecord.java +++ b/src/java/org/apache/poi/hssf/record/NumberRecord.java @@ -89,9 +89,9 @@ public class NumberRecord /** * Constructs a Number record and sets its fields appropriately. * - * @param short id must be 0x203 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x203 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) */ public NumberRecord(short id, short size, byte [] data) @@ -102,9 +102,9 @@ public class NumberRecord /** * Constructs a Number record and sets its fields appropriately. * - * @param short id must be 0x203 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x203 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 offset of the data */ diff --git a/src/java/org/apache/poi/hssf/record/PasswordRecord.java b/src/java/org/apache/poi/hssf/record/PasswordRecord.java index 553f4402b6..005ed43e5e 100644 --- a/src/java/org/apache/poi/hssf/record/PasswordRecord.java +++ b/src/java/org/apache/poi/hssf/record/PasswordRecord.java @@ -78,9 +78,9 @@ public class PasswordRecord /** * Constructs a Password record and sets its fields appropriately. * - * @param short id must be 0x13 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x13 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) */ public PasswordRecord(short id, short size, byte [] data) @@ -91,9 +91,9 @@ public class PasswordRecord /** * Constructs a Password record and sets its fields appropriately. * - * @param short id must be 0x13 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x13 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 offset of the data */ diff --git a/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java b/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java index 8170c13d29..d2c9d43f8f 100644 --- a/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java +++ b/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java @@ -79,9 +79,9 @@ public class PasswordRev4Record /** * Constructs a PasswordRev4 (PROT4REVPASS) record and sets its fields appropriately. * - * @param short id must be 0x1bc or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1bc 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) */ public PasswordRev4Record(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class PasswordRev4Record /** * Constructs a PasswordRev4 (PROT4REVPASS) record and sets its fields appropriately. * - * @param short id must be 0x1bc or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1bc 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 offset of the data */ diff --git a/src/java/org/apache/poi/hssf/record/PrecisionRecord.java b/src/java/org/apache/poi/hssf/record/PrecisionRecord.java index 7b876bf4e3..2c711b838c 100644 --- a/src/java/org/apache/poi/hssf/record/PrecisionRecord.java +++ b/src/java/org/apache/poi/hssf/record/PrecisionRecord.java @@ -79,9 +79,9 @@ public class PrecisionRecord /** * Constructs a Precision record and sets its fields appropriately. * - * @param short id must be 0xe or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xe 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) */ public PrecisionRecord(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class PrecisionRecord /** * Constructs a Precision record and sets its fields appropriately. * - * @param short id must be 0xe or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xe 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 offset of the record */ diff --git a/src/java/org/apache/poi/hssf/record/PrintGridlinesRecord.java b/src/java/org/apache/poi/hssf/record/PrintGridlinesRecord.java index a8dd6596d6..2916520bc7 100644 --- a/src/java/org/apache/poi/hssf/record/PrintGridlinesRecord.java +++ b/src/java/org/apache/poi/hssf/record/PrintGridlinesRecord.java @@ -78,9 +78,9 @@ public class PrintGridlinesRecord /** * Constructs a PrintGridlines record and sets its fields appropriately. * - * @param short id must be 0x2b or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x2b 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) */ public PrintGridlinesRecord(short id, short size, byte [] data) @@ -91,9 +91,9 @@ public class PrintGridlinesRecord /** * Constructs a PrintGridlines record and sets its fields appropriately. * - * @param short id must be 0x2b or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x2b 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 offset of the record data */ diff --git a/src/java/org/apache/poi/hssf/record/PrintHeadersRecord.java b/src/java/org/apache/poi/hssf/record/PrintHeadersRecord.java index 333ba5eccf..f481464db5 100644 --- a/src/java/org/apache/poi/hssf/record/PrintHeadersRecord.java +++ b/src/java/org/apache/poi/hssf/record/PrintHeadersRecord.java @@ -79,9 +79,9 @@ public class PrintHeadersRecord /** * Constructs a PrintHeaders record and sets its fields appropriately. * - * @param short id must be 0x2a or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x2a 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) */ public PrintHeadersRecord(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class PrintHeadersRecord /** * Constructs a PrintHeaders record and sets its fields appropriately. * - * @param short id must be 0x2a or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x2a 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 offset of the data */ diff --git a/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java b/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java index 9a09f82b1b..4391f4ae74 100644 --- a/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java +++ b/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java @@ -108,9 +108,9 @@ public class PrintSetupRecord /** * Constructs a PrintSetup (SETUP) record and sets its fields appropriately. * - * @param short id must be 0xa1 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xa1 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) */ public PrintSetupRecord(short id, short size, byte [] data) @@ -121,9 +121,9 @@ public class PrintSetupRecord /** * Constructs a PrintSetup (SETUP) record and sets its fields appropriately. * - * @param short id must be 0xa1 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xa1 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) */ public PrintSetupRecord(short id, short size, byte [] data, int offset) diff --git a/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java b/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java index 6c203f3e4f..0ec7791b62 100644 --- a/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java +++ b/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java @@ -79,9 +79,9 @@ public class ProtectionRev4Record /** * Constructs a ProtectionRev4 record and sets its fields appropriately. * - * @param short id must be 0x1af or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1af 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) */ public ProtectionRev4Record(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class ProtectionRev4Record /** * Constructs a ProtectionRev4 record and sets its fields appropriately. * - * @param short id must be 0x1af or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1af 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 offset of the data */ diff --git a/src/java/org/apache/poi/hssf/record/RKRecord.java b/src/java/org/apache/poi/hssf/record/RKRecord.java index 544668d28e..40a3ada191 100644 --- a/src/java/org/apache/poi/hssf/record/RKRecord.java +++ b/src/java/org/apache/poi/hssf/record/RKRecord.java @@ -96,9 +96,9 @@ public class RKRecord /** * Constructs a RK record and sets its fields appropriately. * - * @param short id must be 0x27e or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x27e 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) */ public RKRecord(short id, short size, byte [] data) @@ -109,9 +109,9 @@ public class RKRecord /** * Constructs a RK record and sets its fields appropriately. * - * @param short id must be 0x27e or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x27e 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 offset of the data */ diff --git a/src/java/org/apache/poi/hssf/record/RefModeRecord.java b/src/java/org/apache/poi/hssf/record/RefModeRecord.java index df06d55c72..5c8a838215 100644 --- a/src/java/org/apache/poi/hssf/record/RefModeRecord.java +++ b/src/java/org/apache/poi/hssf/record/RefModeRecord.java @@ -80,9 +80,9 @@ public class RefModeRecord /** * Constructs a RefMode record and sets its fields appropriately. * - * @param short id must be 0xf or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xf 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) */ public RefModeRecord(short id, short size, byte [] data) @@ -93,9 +93,9 @@ public class RefModeRecord /** * Constructs a RefMode record and sets its fields appropriately. * - * @param short id must be 0xf or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0xf 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java b/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java index edf9403d0c..109f10f119 100644 --- a/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java +++ b/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java @@ -79,9 +79,9 @@ public class RefreshAllRecord /** * Constructs a RefreshAll record and sets its fields appropriately. * - * @param short id must be 0x187 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x187 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) */ public RefreshAllRecord(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class RefreshAllRecord /** * Constructs a RefreshAll record and sets its fields appropriately. * - * @param short id must be 0x187 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x187 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 offset of the record data */ diff --git a/src/java/org/apache/poi/hssf/record/RowRecord.java b/src/java/org/apache/poi/hssf/record/RowRecord.java index 36232656a1..b21028222c 100644 --- a/src/java/org/apache/poi/hssf/record/RowRecord.java +++ b/src/java/org/apache/poi/hssf/record/RowRecord.java @@ -96,9 +96,9 @@ public class RowRecord /** * Constructs a Row record and sets its fields appropriately. * - * @param short id must be 0x208 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x208 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) */ public RowRecord(short id, short size, byte [] data) @@ -109,9 +109,9 @@ public class RowRecord /** * Constructs a Row record and sets its fields appropriately. * - * @param short id must be 0x208 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x208 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 offset of the record data */ diff --git a/src/java/org/apache/poi/hssf/record/SaveRecalcRecord.java b/src/java/org/apache/poi/hssf/record/SaveRecalcRecord.java index 3597ad2a58..c445479db6 100644 --- a/src/java/org/apache/poi/hssf/record/SaveRecalcRecord.java +++ b/src/java/org/apache/poi/hssf/record/SaveRecalcRecord.java @@ -78,9 +78,9 @@ public class SaveRecalcRecord /** * Constructs an SaveRecalc record and sets its fields appropriately. * - * @param short id must be 0x5f or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x5f 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) */ public SaveRecalcRecord(short id, short size, byte [] data) @@ -91,9 +91,9 @@ public class SaveRecalcRecord /** * Constructs an SaveRecalc record and sets its fields appropriately. * - * @param short id must be 0x5f or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x5f 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 offset of the the data */ diff --git a/src/java/org/apache/poi/hssf/record/SelectionRecord.java b/src/java/org/apache/poi/hssf/record/SelectionRecord.java index 7d98f7f75e..85390dbe1b 100644 --- a/src/java/org/apache/poi/hssf/record/SelectionRecord.java +++ b/src/java/org/apache/poi/hssf/record/SelectionRecord.java @@ -88,9 +88,9 @@ public class SelectionRecord /** * Constructs a Selection record and sets its fields appropriately. * - * @param short id must be 0x1d or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1d 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) */ public SelectionRecord(short id, short size, byte [] data) @@ -101,9 +101,9 @@ public class SelectionRecord /** * Constructs a Selection record and sets its fields appropriately. * - * @param short id must be 0x1d or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x1d 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/StyleRecord.java b/src/java/org/apache/poi/hssf/record/StyleRecord.java index e4721d2ec9..99ff287572 100644 --- a/src/java/org/apache/poi/hssf/record/StyleRecord.java +++ b/src/java/org/apache/poi/hssf/record/StyleRecord.java @@ -91,9 +91,9 @@ public class StyleRecord /** * Constructs a Style record and sets its fields appropriately. * - * @param short id must be 0x293 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x293 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) */ public StyleRecord(short id, short size, byte [] data) @@ -104,9 +104,9 @@ public class StyleRecord /** * Constructs a Style record and sets its fields appropriately. * - * @param short id must be 0x293 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x293 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 offset */ diff --git a/src/java/org/apache/poi/hssf/record/TabIdRecord.java b/src/java/org/apache/poi/hssf/record/TabIdRecord.java index ea6f5ebc3d..d686d8064b 100644 --- a/src/java/org/apache/poi/hssf/record/TabIdRecord.java +++ b/src/java/org/apache/poi/hssf/record/TabIdRecord.java @@ -79,9 +79,9 @@ public class TabIdRecord /** * Constructs a TabID record and sets its fields appropriately. * - * @param short id must be 0x13d or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x13d 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) */ public TabIdRecord(short id, short size, byte [] data) @@ -92,9 +92,9 @@ public class TabIdRecord /** * Constructs a TabID record and sets its fields appropriately. * - * @param short id must be 0x13d or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x13d 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 offset of the record */ diff --git a/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java b/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java index 83a95ef83f..7030724d59 100644 --- a/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java +++ b/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java @@ -81,9 +81,9 @@ public class UseSelFSRecord /** * Constructs a UseSelFS record and sets its fields appropriately. * - * @param short id must be 0x160 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x160 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) */ public UseSelFSRecord(short id, short size, byte [] data) @@ -94,9 +94,9 @@ public class UseSelFSRecord /** * Constructs a UseSelFS record and sets its fields appropriately. * - * @param short id must be 0x160 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x160 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 offset of record */ diff --git a/src/java/org/apache/poi/hssf/record/VCenterRecord.java b/src/java/org/apache/poi/hssf/record/VCenterRecord.java index 9c78250dce..c8b5489201 100644 --- a/src/java/org/apache/poi/hssf/record/VCenterRecord.java +++ b/src/java/org/apache/poi/hssf/record/VCenterRecord.java @@ -78,9 +78,9 @@ public class VCenterRecord /** * Constructs a VCENTER record and sets its fields appropriately. * - * @param short id must be 0x84 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x84 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) */ public VCenterRecord(short id, short size, byte [] data) @@ -91,9 +91,9 @@ public class VCenterRecord /** * Constructs a VCENTER record and sets its fields appropriately. * - * @param short id must be 0x84 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x84 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/WSBoolRecord.java b/src/java/org/apache/poi/hssf/record/WSBoolRecord.java index e045665537..4c0d826065 100644 --- a/src/java/org/apache/poi/hssf/record/WSBoolRecord.java +++ b/src/java/org/apache/poi/hssf/record/WSBoolRecord.java @@ -108,9 +108,9 @@ public class WSBoolRecord /** * Constructs a WSBool record and sets its fields appropriately. * - * @param short id must be 0x81 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x81 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) */ public WSBoolRecord(short id, short size, byte [] data) @@ -121,9 +121,9 @@ public class WSBoolRecord /** * Constructs a WSBool record and sets its fields appropriately. * - * @param short id must be 0x81 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x81 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) */ public WSBoolRecord(short id, short size, byte [] data, int offset) diff --git a/src/java/org/apache/poi/hssf/record/WindowOneRecord.java b/src/java/org/apache/poi/hssf/record/WindowOneRecord.java index 694189a097..41c779ed12 100644 --- a/src/java/org/apache/poi/hssf/record/WindowOneRecord.java +++ b/src/java/org/apache/poi/hssf/record/WindowOneRecord.java @@ -104,9 +104,9 @@ public class WindowOneRecord /** * Constructs a WindowOne record and sets its fields appropriately. * - * @param short id must be 0x3d or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x3d 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) */ public WindowOneRecord(short id, short size, byte [] data) @@ -117,9 +117,9 @@ public class WindowOneRecord /** * Constructs a WindowOne record and sets its fields appropriately. * - * @param short id must be 0x3d or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x3d 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) */ public WindowOneRecord(short id, short size, byte [] data, int offset) diff --git a/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java b/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java index 63d868a665..1f4095dae5 100644 --- a/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java +++ b/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java @@ -78,9 +78,9 @@ public class WindowProtectRecord /** * Constructs a WindowProtect record and sets its fields appropriately. * - * @param short id must be 0x19 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x19 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) */ public WindowProtectRecord(short id, short size, byte [] data) @@ -91,9 +91,9 @@ public class WindowProtectRecord /** * Constructs a WindowProtect record and sets its fields appropriately. * - * @param short id must be 0x19 or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x19 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/WindowTwoRecord.java b/src/java/org/apache/poi/hssf/record/WindowTwoRecord.java index b2ac56c4da..b3e8fc7d31 100644 --- a/src/java/org/apache/poi/hssf/record/WindowTwoRecord.java +++ b/src/java/org/apache/poi/hssf/record/WindowTwoRecord.java @@ -107,9 +107,9 @@ public class WindowTwoRecord /** * Constructs a WindowTwo record and sets its fields appropriately. * - * @param short id must be 0x23e or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x23e 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) */ public WindowTwoRecord(short id, short size, byte [] data) @@ -120,9 +120,9 @@ public class WindowTwoRecord /** * Constructs a WindowTwo record and sets its fields appropriately. * - * @param short id must be 0x23e or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x23e 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 offset of the record's data */ diff --git a/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java b/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java index 8c3967eefe..c35b94c851 100644 --- a/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java +++ b/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java @@ -81,9 +81,9 @@ public class WriteAccessRecord /** * Constructs a WriteAccess record and sets its fields appropriately. * - * @param short id must be 0x5c or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x5c 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) */ public WriteAccessRecord(short id, short size, byte [] data) @@ -94,9 +94,9 @@ public class WriteAccessRecord /** * Constructs a WriteAccess record and sets its fields appropriately. * - * @param short id must be 0x5c or an exception will be throw upon validation - * @param short size the size of the data area of the record - * @param byte[] data of the record (should not contain sid/len) + * @param id id must be 0x5c 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 offset of the record data */