From f83ff6f8ce74c9ab414b98ac50a72c33d3c12931 Mon Sep 17 00:00:00 2001 From: Andreas Beeker Date: Mon, 13 Jun 2016 23:08:13 +0000 Subject: [PATCH] javadoc fixes (jdk8) git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1748328 13f79535-47bb-0310-9956-ffa450edef68 --- .../apache/poi/hssf/record/FooterRecord.java | 10 ++---- .../apache/poi/hssf/record/FormatRecord.java | 8 ++--- .../poi/hssf/record/GroupMarkerSubRecord.java | 7 ++-- .../record/HorizontalPageBreakRecord.java | 7 ++-- .../apache/poi/hssf/record/IndexRecord.java | 10 +++--- .../poi/hssf/record/IterationRecord.java | 12 +++---- .../poi/hssf/record/LeftMarginRecord.java | 4 +-- .../poi/hssf/record/MergeCellsRecord.java | 7 ++-- .../poi/hssf/record/MulBlankRecord.java | 11 +++---- .../apache/poi/hssf/record/MulRKRecord.java | 8 ++--- .../poi/hssf/record/NameCommentRecord.java | 9 ++---- .../apache/poi/hssf/record/NameRecord.java | 9 ++---- .../apache/poi/hssf/record/NoteRecord.java | 4 +-- .../hssf/record/NoteStructureSubRecord.java | 8 ++--- .../org/apache/poi/hssf/record/ObjRecord.java | 4 +-- .../apache/poi/hssf/record/PaneRecord.java | 4 +-- .../poi/hssf/record/PasswordRecord.java | 6 ++-- .../poi/hssf/record/PasswordRev4Record.java | 7 ++-- .../poi/hssf/record/PrintSetupRecord.java | 13 ++++---- .../apache/poi/hssf/record/ProtectRecord.java | 7 ++-- .../poi/hssf/record/ProtectionRev4Record.java | 7 ++-- .../org/apache/poi/hssf/record/RKRecord.java | 13 +++----- .../poi/hssf/record/RecalcIdRecord.java | 13 ++++---- .../apache/poi/hssf/record/RecordFactory.java | 12 +++---- .../poi/hssf/record/RefreshAllRecord.java | 7 ++-- .../poi/hssf/record/RightMarginRecord.java | 4 +-- .../org/apache/poi/hssf/record/RowRecord.java | 11 +++---- .../org/apache/poi/hssf/record/SCLRecord.java | 4 +-- .../org/apache/poi/hssf/record/SSTRecord.java | 32 +++++++++---------- .../apache/poi/hssf/record/StringRecord.java | 4 +-- .../apache/poi/hssf/record/StyleRecord.java | 8 ++--- .../apache/poi/hssf/record/SupBookRecord.java | 9 ++---- .../apache/poi/hssf/record/TabIdRecord.java | 8 ++--- .../apache/poi/hssf/record/TableRecord.java | 2 +- .../poi/hssf/record/TableStylesRecord.java | 4 +-- .../poi/hssf/record/TextObjectRecord.java | 4 +-- .../poi/hssf/record/TopMarginRecord.java | 4 +-- .../apache/poi/hssf/record/UnknownRecord.java | 11 +++---- .../poi/hssf/record/UseSelFSRecord.java | 7 ++-- .../hssf/record/VerticalPageBreakRecord.java | 3 +- .../apache/poi/hssf/record/WSBoolRecord.java | 9 ++---- .../poi/hssf/record/WindowProtectRecord.java | 6 ++-- .../poi/hssf/record/WriteAccessRecord.java | 7 ++-- .../ChartSubstreamRecordAggregate.java | 4 +-- .../ConditionalFormattingTable.java | 2 +- .../CustomViewSettingsRecordAggregate.java | 4 +-- .../record/aggregates/DataValidityTable.java | 3 +- .../record/aggregates/PageSettingsBlock.java | 4 +-- .../org/apache/poi/POIXMLDocumentPart.java | 24 +++++++++++--- .../java/org/apache/poi/POIXMLFactory.java | 19 +++++++++++ .../java/org/apache/poi/POIXMLProperties.java | 23 +++++++++++++ 51 files changed, 199 insertions(+), 228 deletions(-) diff --git a/src/java/org/apache/poi/hssf/record/FooterRecord.java b/src/java/org/apache/poi/hssf/record/FooterRecord.java index 5031f54cb..e5e98bb0b 100644 --- a/src/java/org/apache/poi/hssf/record/FooterRecord.java +++ b/src/java/org/apache/poi/hssf/record/FooterRecord.java @@ -18,13 +18,9 @@ package org.apache.poi.hssf.record; /** - * Title: Footer Record (0x0015)

- * Description: Specifies the footer for a sheet

- * REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02 - * @author Jason Height (jheight at chariot dot net dot au) - * + * Title: Footer Record (0x0015)

+ * Description: Specifies the footer for a sheet

+ * REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class FooterRecord extends HeaderFooterBase implements Cloneable { public final static short sid = 0x0015; diff --git a/src/java/org/apache/poi/hssf/record/FormatRecord.java b/src/java/org/apache/poi/hssf/record/FormatRecord.java index 1508bb6fc..955c52c22 100644 --- a/src/java/org/apache/poi/hssf/record/FormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/FormatRecord.java @@ -22,12 +22,10 @@ import org.apache.poi.util.LittleEndianOutput; import org.apache.poi.util.StringUtil; /** - * Title: Format Record (0x041E)

- * Description: describes a number format -- those goofy strings like $(#,###)

+ * Title: Format Record (0x041E)

+ * Description: describes a number format -- those goofy strings like $(#,###)

* - * REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author Shawn M. Laubach (slaubach at apache dot org) + * REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class FormatRecord extends StandardRecord implements Cloneable { public final static short sid = 0x041E; diff --git a/src/java/org/apache/poi/hssf/record/GroupMarkerSubRecord.java b/src/java/org/apache/poi/hssf/record/GroupMarkerSubRecord.java index b59f9d1d8..c7af79ee3 100644 --- a/src/java/org/apache/poi/hssf/record/GroupMarkerSubRecord.java +++ b/src/java/org/apache/poi/hssf/record/GroupMarkerSubRecord.java @@ -22,17 +22,16 @@ import org.apache.poi.util.LittleEndianInput; import org.apache.poi.util.LittleEndianOutput; /** - * ftGmo (0x0006)

+ * ftGmo (0x0006)

* The group marker record is used as a position holder for groups. - - * @author Glen Stampoultzis (glens at apache.org) */ public final class GroupMarkerSubRecord extends SubRecord implements Cloneable { public final static short sid = 0x0006; private static final byte[] EMPTY_BYTE_ARRAY = { }; - private byte[] reserved; // would really love to know what goes in here. + // would really love to know what goes in here. + private byte[] reserved; public GroupMarkerSubRecord() { reserved = EMPTY_BYTE_ARRAY; diff --git a/src/java/org/apache/poi/hssf/record/HorizontalPageBreakRecord.java b/src/java/org/apache/poi/hssf/record/HorizontalPageBreakRecord.java index 7e18f4650..ff034ef55 100644 --- a/src/java/org/apache/poi/hssf/record/HorizontalPageBreakRecord.java +++ b/src/java/org/apache/poi/hssf/record/HorizontalPageBreakRecord.java @@ -20,10 +20,9 @@ package org.apache.poi.hssf.record; import java.util.Iterator; /** - * HorizontalPageBreak (0x001B) record that stores page breaks at rows

+ * HorizontalPageBreak (0x001B) record that stores page breaks at rows * * @see PageBreakRecord - * @author Danny Mui (dmui at apache dot org) */ public final class HorizontalPageBreakRecord extends PageBreakRecord implements Cloneable { @@ -33,12 +32,10 @@ public final class HorizontalPageBreakRecord extends PageBreakRecord implements * Creates an empty horizontal page break record */ public HorizontalPageBreakRecord() { - // } /** - * @param in - * the RecordInputstream to read the record from + * @param in the RecordInputstream to read the record from */ public HorizontalPageBreakRecord(RecordInputStream in) { super(in); diff --git a/src/java/org/apache/poi/hssf/record/IndexRecord.java b/src/java/org/apache/poi/hssf/record/IndexRecord.java index ca1ad35e4..a54fb656c 100644 --- a/src/java/org/apache/poi/hssf/record/IndexRecord.java +++ b/src/java/org/apache/poi/hssf/record/IndexRecord.java @@ -21,13 +21,11 @@ import org.apache.poi.util.IntList; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Index Record (0x020B)

+ * Title: Index Record (0x020B)

* Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet - * Important for locating cells

- * NOT USED IN THIS RELEASE - * REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author Jason Height (jheight at chariot dot net dot au) + * Important for locating cells

+ * + * REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class IndexRecord extends StandardRecord implements Cloneable { public final static short sid = 0x020B; diff --git a/src/java/org/apache/poi/hssf/record/IterationRecord.java b/src/java/org/apache/poi/hssf/record/IterationRecord.java index 4d7f4546d..8a7595ce4 100644 --- a/src/java/org/apache/poi/hssf/record/IterationRecord.java +++ b/src/java/org/apache/poi/hssf/record/IterationRecord.java @@ -23,14 +23,12 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Iteration Record (0x0011)

- * Description: Tells whether to iterate over forumla calculations or not - * (if a formula is dependant upon another formula's result) + * Title: Iteration Record (0x0011)

+ * Description: Tells whether to iterate over formula calculations or not + * (if a formula is dependent upon another formula's result) * (odd feature for something that can only have 32 elements in - * a formula!)

- * REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author Jason Height (jheight at chariot dot net dot au) + * a formula!)

+ * REFERENCE: PG 325 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class IterationRecord extends StandardRecord implements Cloneable { public final static short sid = 0x0011; diff --git a/src/java/org/apache/poi/hssf/record/LeftMarginRecord.java b/src/java/org/apache/poi/hssf/record/LeftMarginRecord.java index 5b570487d..6e8cb8fbb 100644 --- a/src/java/org/apache/poi/hssf/record/LeftMarginRecord.java +++ b/src/java/org/apache/poi/hssf/record/LeftMarginRecord.java @@ -20,9 +20,7 @@ package org.apache.poi.hssf.record; import org.apache.poi.util.LittleEndianOutput; /** - * Record for the left margin.

- * - * @author Shawn Laubach (slaubach at apache dot org) + * Record for the left margin. */ public final class LeftMarginRecord extends StandardRecord implements Margin, Cloneable { public final static short sid = 0x0026; diff --git a/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java b/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java index 9fbc676a1..227a019ec 100644 --- a/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java +++ b/src/java/org/apache/poi/hssf/record/MergeCellsRecord.java @@ -22,10 +22,9 @@ import org.apache.poi.ss.util.CellRangeAddressList; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Merged Cells Record (0x00E5) - *
- * Description: Optional record defining a square area of cells to "merged" into one cell.
- * @author Andrew C. Oliver (acoliver at apache dot org) + * Title: Merged Cells Record (0x00E5)

+ * + * Description: Optional record defining a square area of cells to "merged" into one cell. */ public final class MergeCellsRecord extends StandardRecord implements Cloneable { public final static short sid = 0x00E5; diff --git a/src/java/org/apache/poi/hssf/record/MulBlankRecord.java b/src/java/org/apache/poi/hssf/record/MulBlankRecord.java index f48ba5030..cbdcd2a93 100644 --- a/src/java/org/apache/poi/hssf/record/MulBlankRecord.java +++ b/src/java/org/apache/poi/hssf/record/MulBlankRecord.java @@ -20,12 +20,11 @@ package org.apache.poi.hssf.record; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Multiple Blank cell record(0x00BE)

- * Description: Represents a set of columns in a row with no value but with styling. - *

- * REFERENCE: PG 329 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author Glen Stampoultzis (glens at apache.org) + * Title: Multiple Blank cell record(0x00BE)

+ * Description: Represents a set of columns in a row with no value but with styling.

+ * + * REFERENCE: PG 329 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) + * * @see BlankRecord */ public final class MulBlankRecord extends StandardRecord { diff --git a/src/java/org/apache/poi/hssf/record/MulRKRecord.java b/src/java/org/apache/poi/hssf/record/MulRKRecord.java index 3c1390d07..f0629ca2d 100644 --- a/src/java/org/apache/poi/hssf/record/MulRKRecord.java +++ b/src/java/org/apache/poi/hssf/record/MulRKRecord.java @@ -22,13 +22,13 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * MULRK (0x00BD)

+ * MULRK (0x00BD)

* * Used to store multiple RK numbers on a row. 1 MulRk = Multiple Cell values. * HSSF just converts this into multiple NUMBER records. READ-ONLY SUPPORT!

- * REFERENCE: PG 330 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @version 2.0-pre + * REFERENCE: PG 330 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) + * + * @since 2.0-pre */ public final class MulRKRecord extends StandardRecord { public final static short sid = 0x00BD; diff --git a/src/java/org/apache/poi/hssf/record/NameCommentRecord.java b/src/java/org/apache/poi/hssf/record/NameCommentRecord.java index 6b3c8d0bd..dc7a9b3c3 100644 --- a/src/java/org/apache/poi/hssf/record/NameCommentRecord.java +++ b/src/java/org/apache/poi/hssf/record/NameCommentRecord.java @@ -23,14 +23,9 @@ import org.apache.poi.util.LittleEndianOutput; import org.apache.poi.util.StringUtil; /** - * Title: NAMECMT Record (0x0894) - *

+ * Title: NAMECMT Record (0x0894)

+ * * Description: Defines a comment associated with a specified name. - *

- * REFERENCE: - *

- * - * @author Andrew Shirley (aks at corefiling.co.uk) */ public final class NameCommentRecord extends StandardRecord { public final static short sid = 0x0894; diff --git a/src/java/org/apache/poi/hssf/record/NameRecord.java b/src/java/org/apache/poi/hssf/record/NameRecord.java index 2f7f81899..1e44ed651 100644 --- a/src/java/org/apache/poi/hssf/record/NameRecord.java +++ b/src/java/org/apache/poi/hssf/record/NameRecord.java @@ -26,13 +26,8 @@ import org.apache.poi.ss.formula.Formula; import org.apache.poi.util.*; /** - * Title: DEFINEDNAME Record (0x0018)

- * Description: Defines a named range within a workbook.

- * REFERENCE:

- * @author Libin Roman (Vista Portal LDT. Developer) - * @author Sergei Kozello (sergeikozello at mail.ru) - * @author Glen Stampoultzis (glens at apache.org) - * @author Petr Udalau - added method setFunction(boolean) + * Title: DEFINEDNAME Record (0x0018)

+ * Description: Defines a named range within a workbook. */ public final class NameRecord extends ContinuableRecord { public final static short sid = 0x0018; diff --git a/src/java/org/apache/poi/hssf/record/NoteRecord.java b/src/java/org/apache/poi/hssf/record/NoteRecord.java index 261a523c0..6fadf861d 100644 --- a/src/java/org/apache/poi/hssf/record/NoteRecord.java +++ b/src/java/org/apache/poi/hssf/record/NoteRecord.java @@ -21,9 +21,7 @@ import org.apache.poi.util.LittleEndianOutput; import org.apache.poi.util.StringUtil; /** - * NOTE: Comment Associated with a Cell (0x001C)

- * - * @author Yegor Kozlov + * NOTE: Comment Associated with a Cell (0x001C) */ public final class NoteRecord extends StandardRecord implements Cloneable { public final static short sid = 0x001C; diff --git a/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java b/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java index 50e79173a..7780b1583 100644 --- a/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java +++ b/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java @@ -22,14 +22,10 @@ import org.apache.poi.util.LittleEndianInput; import org.apache.poi.util.LittleEndianOutput; /** - * ftNts (0x000D)

- * Represents a NoteStructure sub record. + * ftNts (0x000D)

+ * Represents a NoteStructure sub record.

* - *

* The docs say nothing about it. The length of this record is always 26 bytes. - *

- * - * @author Yegor Kozlov */ public final class NoteStructureSubRecord extends SubRecord implements Cloneable { public final static short sid = 0x0D; diff --git a/src/java/org/apache/poi/hssf/record/ObjRecord.java b/src/java/org/apache/poi/hssf/record/ObjRecord.java index cce80f6be..8eb4e03af 100644 --- a/src/java/org/apache/poi/hssf/record/ObjRecord.java +++ b/src/java/org/apache/poi/hssf/record/ObjRecord.java @@ -27,11 +27,9 @@ import org.apache.poi.util.LittleEndianByteArrayOutputStream; import org.apache.poi.util.LittleEndianInputStream; /** - * OBJRECORD (0x005D)

+ * OBJRECORD (0x005D)

* * The obj record is used to hold various graphic objects and controls. - * - * @author Glen Stampoultzis (glens at apache.org) */ public final class ObjRecord extends Record implements Cloneable { public final static short sid = 0x005D; diff --git a/src/java/org/apache/poi/hssf/record/PaneRecord.java b/src/java/org/apache/poi/hssf/record/PaneRecord.java index dddd92991..ea7d967ad 100644 --- a/src/java/org/apache/poi/hssf/record/PaneRecord.java +++ b/src/java/org/apache/poi/hssf/record/PaneRecord.java @@ -22,9 +22,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Describes the frozen and unfozen panes.

- * - * @author Glen Stampoultzis (glens at apache.org) + * Describes the frozen and unfrozen panes. */ public final class PaneRecord extends StandardRecord { public final static short sid = 0x41; diff --git a/src/java/org/apache/poi/hssf/record/PasswordRecord.java b/src/java/org/apache/poi/hssf/record/PasswordRecord.java index c38a1230c..dc7a4c395 100644 --- a/src/java/org/apache/poi/hssf/record/PasswordRecord.java +++ b/src/java/org/apache/poi/hssf/record/PasswordRecord.java @@ -22,11 +22,9 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Password Record (0x0013)

+ * Title: Password Record (0x0013)

* Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption) - * REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * + * REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class PasswordRecord extends StandardRecord { public final static short sid = 0x0013; diff --git a/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java b/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java index 8786bf965..16ef49a6f 100644 --- a/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java +++ b/src/java/org/apache/poi/hssf/record/PasswordRev4Record.java @@ -21,10 +21,9 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Protection Revision 4 password Record (0x01BC)

- * Description: Stores the (2 byte??!!) encrypted password for a shared workbook

- * REFERENCE: PG 374 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) + * Title: Protection Revision 4 password Record (0x01BC)

+ * Description: Stores the (2 byte??!!) encrypted password for a shared workbook

+ * REFERENCE: PG 374 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class PasswordRev4Record extends StandardRecord { public final static short sid = 0x01BC; diff --git a/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java b/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java index 96f52b767..9ab4fe1a6 100644 --- a/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java +++ b/src/java/org/apache/poi/hssf/record/PrintSetupRecord.java @@ -23,13 +23,12 @@ import org.apache.poi.util.BitField; import org.apache.poi.util.BitFieldFactory; /** - * Title: PAGESETUP (0x00A1)

- * Description: Stores print setup options -- bogus for HSSF (and marked as such)

- * REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * REFERENCE: PG 412 Microsoft Excel Binary File Format Structure v20091214

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author Jason Height (jheight at chariot dot net dot au) - * @version 2.0-pre + * Title: PAGESETUP (0x00A1)

+ * Description: Stores print setup options -- bogus for HSSF (and marked as such)

+ * REFERENCE: PG 385 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

+ * REFERENCE: PG 412 Microsoft Excel Binary File Format Structure v20091214 + * + * @since 2.0-pre */ public final class PrintSetupRecord extends StandardRecord { public final static short sid = 0x00A1; diff --git a/src/java/org/apache/poi/hssf/record/ProtectRecord.java b/src/java/org/apache/poi/hssf/record/ProtectRecord.java index fcf68dcbb..dca418e07 100644 --- a/src/java/org/apache/poi/hssf/record/ProtectRecord.java +++ b/src/java/org/apache/poi/hssf/record/ProtectRecord.java @@ -23,12 +23,11 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Protect Record (0x0012)

- * Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)

+ * Title: Protect Record (0x0012)

+ * Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)

* HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al * ignore the password record entirely). - * REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) + * REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class ProtectRecord extends StandardRecord { public final static short sid = 0x0012; diff --git a/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java b/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java index 64a4460be..6a9ca300f 100644 --- a/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java +++ b/src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java @@ -23,10 +23,9 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Protection Revision 4 Record (0x01AF)

- * Description: describes whether this is a protected shared/tracked workbook

- * REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) + * Title: Protection Revision 4 Record (0x01AF)

+ * Description: describes whether this is a protected shared/tracked workbook

+ * REFERENCE: PG 373 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class ProtectionRev4Record extends StandardRecord { public final static short sid = 0x01AF; diff --git a/src/java/org/apache/poi/hssf/record/RKRecord.java b/src/java/org/apache/poi/hssf/record/RKRecord.java index d3babe8f3..3aac08d69 100644 --- a/src/java/org/apache/poi/hssf/record/RKRecord.java +++ b/src/java/org/apache/poi/hssf/record/RKRecord.java @@ -21,19 +21,16 @@ import org.apache.poi.hssf.util.RKUtil; import org.apache.poi.util.LittleEndianOutput; /** - * Title: RK Record (0x027E)

+ * Title: RK Record (0x027E)

* Description: An internal 32 bit number with the two most significant bits * storing the type. This is part of a bizarre scheme to save disk * space and memory (gee look at all the other whole records that * are in the file just "cause"..,far better to waste processor - * cycles on this then leave on of those "valuable" records out).

- * We support this in READ-ONLY mode. HSSF converts these to NUMBER records

+ * cycles on this then leave on of those "valuable" records out).

+ * We support this in READ-ONLY mode. HSSF converts these to NUMBER records

* - * - * - * REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author Jason Height (jheight at chariot dot net dot au) + * REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) + * * @see org.apache.poi.hssf.record.NumberRecord */ public final class RKRecord extends CellRecord { diff --git a/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java b/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java index 3837a0235..e890b43f9 100644 --- a/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java +++ b/src/java/org/apache/poi/hssf/record/RecalcIdRecord.java @@ -21,16 +21,15 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Recalc Id Record (0x01C1)

+ * Title: Recalc Id Record (0x01C1)

* Description: This record contains an ID that marks when a worksheet was last * recalculated. It's an optimization Excel uses to determine if it * needs to recalculate the spreadsheet when it's opened. So far, only - * the two engine ids 0x80 0x38 0x01 0x00 - * and 0x60 0x69 0x01 0x00 have been seen. - * A value of 0x00 will cause Excel to recalculate - * all formulas on the next load.

- * REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html

- * @author Luc Girardin (luc dot girardin at macrofocus dot com) + * the two engine ids {@code 0x80 0x38 0x01 0x00} + * and {@code 0x60 0x69 0x01 0x00} have been seen. + * A value of {@code 0x00} will cause Excel to recalculate + * all formulas on the next load.

+ * REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html */ public final class RecalcIdRecord extends StandardRecord { public final static short sid = 0x01C1; diff --git a/src/java/org/apache/poi/hssf/record/RecordFactory.java b/src/java/org/apache/poi/hssf/record/RecordFactory.java index 9bd3bdf66..d56eec0c2 100644 --- a/src/java/org/apache/poi/hssf/record/RecordFactory.java +++ b/src/java/org/apache/poi/hssf/record/RecordFactory.java @@ -59,8 +59,8 @@ import org.apache.poi.hssf.record.pivottable.ViewFieldsRecord; import org.apache.poi.hssf.record.pivottable.ViewSourceRecord; /** - * Title: Record Factory

- * Description: Takes a stream and outputs an array of Record objects.

+ * Title: Record Factory

+ * Description: Takes a stream and outputs an array of Record objects. * * @see org.apache.poi.hssf.eventmodel.EventRecordFactory */ @@ -291,12 +291,12 @@ public final class RecordFactory { private static short[] _allKnownRecordSIDs; /** - * Debug / diagnosis method
- * Gets the POI implementation class for a given sid. Only a subset of the any BIFF + * Debug / diagnosis method

+ * Gets the POI implementation class for a given {@code sid}. Only a subset of the any BIFF * records are actually interpreted by POI. A few others are known but not interpreted * (see {@link UnknownRecord#getBiffName(int)}). - * @return the POI implementation class for the specified record sid. - * null if the specified record is not interpreted by POI. + * @return the POI implementation class for the specified record {@code sid}. + * {@code null} if the specified record is not interpreted by POI. */ public static Class getRecordClass(int sid) { I_RecordCreator rc = _recordCreatorsById.get(Integer.valueOf(sid)); diff --git a/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java b/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java index 055a247d6..a6e547fea 100644 --- a/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java +++ b/src/java/org/apache/poi/hssf/record/RefreshAllRecord.java @@ -23,11 +23,10 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Refresh All Record (0x01B7)

+ * Title: Refresh All Record (0x01B7)

* Description: Flag whether to refresh all external data when loading a sheet. - * (which hssf doesn't support anyhow so who really cares?)

- * REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) + * (which hssf doesn't support anyhow so who really cares?)

+ * REFERENCE: PG 376 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class RefreshAllRecord extends StandardRecord { public final static short sid = 0x01B7; diff --git a/src/java/org/apache/poi/hssf/record/RightMarginRecord.java b/src/java/org/apache/poi/hssf/record/RightMarginRecord.java index fd956e442..09b1d9684 100644 --- a/src/java/org/apache/poi/hssf/record/RightMarginRecord.java +++ b/src/java/org/apache/poi/hssf/record/RightMarginRecord.java @@ -20,9 +20,7 @@ package org.apache.poi.hssf.record; import org.apache.poi.util.LittleEndianOutput; /** - * Record for the right margin.

- * - * @author Shawn Laubach (slaubach at apache dot org) + * Record for the right margin. */ public final class RightMarginRecord extends StandardRecord implements Margin { public final static short sid = 0x27; diff --git a/src/java/org/apache/poi/hssf/record/RowRecord.java b/src/java/org/apache/poi/hssf/record/RowRecord.java index ffbf9c753..20951cb9f 100644 --- a/src/java/org/apache/poi/hssf/record/RowRecord.java +++ b/src/java/org/apache/poi/hssf/record/RowRecord.java @@ -23,12 +23,11 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Row Record (0x0208)

- * Description: stores the row information for the sheet.

- * REFERENCE: PG 379 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author Jason Height (jheight at chariot dot net dot au) - * @version 2.0-pre + * Title: Row Record (0x0208)

+ * Description: stores the row information for the sheet.

+ * REFERENCE: PG 379 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) + * + * @since 2.0-pre */ public final class RowRecord extends StandardRecord { public final static short sid = 0x0208; diff --git a/src/java/org/apache/poi/hssf/record/SCLRecord.java b/src/java/org/apache/poi/hssf/record/SCLRecord.java index 3c2e78583..6ef6aae90 100644 --- a/src/java/org/apache/poi/hssf/record/SCLRecord.java +++ b/src/java/org/apache/poi/hssf/record/SCLRecord.java @@ -21,10 +21,8 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Specifies the window's zoom magnification.

+ * Specifies the window's zoom magnification.

* If this record isn't present then the windows zoom is 100%. see p384 Excel Dev Kit - * - * @author Andrew C. Oliver (acoliver at apache.org) */ public final class SCLRecord extends StandardRecord { public final static short sid = 0x00A0; diff --git a/src/java/org/apache/poi/hssf/record/SSTRecord.java b/src/java/org/apache/poi/hssf/record/SSTRecord.java index 2c0730a4f..43f42defd 100644 --- a/src/java/org/apache/poi/hssf/record/SSTRecord.java +++ b/src/java/org/apache/poi/hssf/record/SSTRecord.java @@ -26,13 +26,11 @@ import org.apache.poi.util.IntMapper; import org.apache.poi.util.LittleEndianConsts; /** - * Title: Static String Table Record (0x00FC)

+ * Title: Static String Table Record (0x00FC)

* - * Description: This holds all the strings for LabelSSTRecords. - *

- * REFERENCE: PG 389 Microsoft Excel 97 Developer's Kit (ISBN: - * 1-57231-498-2) - *

+ * Description: This holds all the strings for LabelSSTRecords.

+ * + * REFERENCE: PG 389 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) * * @see org.apache.poi.hssf.record.LabelSSTRecord * @see org.apache.poi.hssf.record.ContinueRecord @@ -164,7 +162,7 @@ public final class SSTRecord extends ContinuableRecord { * The data consists of sets of string data. This string data is * arranged as follows: *

- * 

+     * 
      * short  string_length;   // length of string data
      * byte   string_flag;     // flag specifying special string
      *                         // handling
@@ -177,11 +175,11 @@ public final class SSTRecord extends ContinuableRecord {
      *                         // array is run_count)
      * byte[] extension;       // optional extension (length of array
      *                         // is extend_length)
-     * 

+     *
*

* The string_flag is bit mapped as follows: *

- * + *
* * * @@ -190,42 +188,42 @@ public final class SSTRecord extends ContinuableRecord { * * * - * * * * * - * * * * * - * * * * * - * * * * * - * * * * * - * * * * * - * * * * * - * * *
Bit numberMeaning if 0
0string_data is byte[]string_data is short[] + * string_data is short[]
1Should always be 0string_flag is defective + * string_flag is defective
2extension is not includedextension is included + * extension is included
3formatting run data is not includedformatting run data is included + * formatting run data is included
4Should always be 0string_flag is defective + * string_flag is defective
5Should always be 0string_flag is defective + * string_flag is defective
6Should always be 0string_flag is defective + * string_flag is defective
7Should always be 0string_flag is defective + * string_flag is defective
*

diff --git a/src/java/org/apache/poi/hssf/record/StringRecord.java b/src/java/org/apache/poi/hssf/record/StringRecord.java index 45322bea4..d2113df06 100644 --- a/src/java/org/apache/poi/hssf/record/StringRecord.java +++ b/src/java/org/apache/poi/hssf/record/StringRecord.java @@ -22,11 +22,9 @@ import org.apache.poi.hssf.record.cont.ContinuableRecordOutput; import org.apache.poi.util.StringUtil; /** - * STRING (0x0207)

+ * STRING (0x0207)

* * Stores the cached result of a text formula - * - * @author Glen Stampoultzis (glens at apache.org) */ public final class StringRecord extends ContinuableRecord { diff --git a/src/java/org/apache/poi/hssf/record/StyleRecord.java b/src/java/org/apache/poi/hssf/record/StyleRecord.java index ee4590902..4d60217a2 100644 --- a/src/java/org/apache/poi/hssf/record/StyleRecord.java +++ b/src/java/org/apache/poi/hssf/record/StyleRecord.java @@ -24,11 +24,9 @@ import org.apache.poi.util.LittleEndianOutput; import org.apache.poi.util.StringUtil; /** - * Title: Style Record (0x0293)

- * Description: Describes a builtin to the gui or user defined style

- * REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author aviks : string fixes for UserDefined Style + * Title: Style Record (0x0293)

+ * Description: Describes a builtin to the gui or user defined style

+ * REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class StyleRecord extends StandardRecord { public final static short sid = 0x0293; diff --git a/src/java/org/apache/poi/hssf/record/SupBookRecord.java b/src/java/org/apache/poi/hssf/record/SupBookRecord.java index b45fa215a..9067c24cc 100644 --- a/src/java/org/apache/poi/hssf/record/SupBookRecord.java +++ b/src/java/org/apache/poi/hssf/record/SupBookRecord.java @@ -23,13 +23,10 @@ import org.apache.poi.util.POILogger; import org.apache.poi.util.StringUtil; /** - * Title: Sup Book - EXTERNALBOOK (0x01AE)

+ * Title: Sup Book - EXTERNALBOOK (0x01AE)

* Description: A External Workbook Description (Supplemental Book) - * Its only a dummy record for making new ExternSheet Record

- * REFERENCE: 5.38

- * @author Libin Roman (Vista Portal LDT. Developer) - * @author Andrew C. Oliver (acoliver@apache.org) - * + * Its only a dummy record for making new ExternSheet Record

+ * REFERENCE: 5.38 */ public final class SupBookRecord extends StandardRecord { diff --git a/src/java/org/apache/poi/hssf/record/TabIdRecord.java b/src/java/org/apache/poi/hssf/record/TabIdRecord.java index e1e9052b0..acc6a0595 100644 --- a/src/java/org/apache/poi/hssf/record/TabIdRecord.java +++ b/src/java/org/apache/poi/hssf/record/TabIdRecord.java @@ -20,12 +20,10 @@ package org.apache.poi.hssf.record; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Sheet Tab Index Array Record (0x013D)

+ * Title: Sheet Tab Index Array Record (0x013D)

* Description: Contains an array of sheet id's. Sheets always keep their ID - * regardless of what their name is.

- * REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * + * regardless of what their name is.

+ * REFERENCE: PG 412 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class TabIdRecord extends StandardRecord { public final static short sid = 0x013D; diff --git a/src/java/org/apache/poi/hssf/record/TableRecord.java b/src/java/org/apache/poi/hssf/record/TableRecord.java index 5835a6fbb..7c42db206 100644 --- a/src/java/org/apache/poi/hssf/record/TableRecord.java +++ b/src/java/org/apache/poi/hssf/record/TableRecord.java @@ -25,7 +25,7 @@ import org.apache.poi.util.BitFieldFactory; import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * DATATABLE (0x0236)

+ * DATATABLE (0x0236)

* * TableRecord - The record specifies a data table. * This record is preceded by a single Formula record that diff --git a/src/java/org/apache/poi/hssf/record/TableStylesRecord.java b/src/java/org/apache/poi/hssf/record/TableStylesRecord.java index 162f541a3..27bd8a71f 100644 --- a/src/java/org/apache/poi/hssf/record/TableStylesRecord.java +++ b/src/java/org/apache/poi/hssf/record/TableStylesRecord.java @@ -22,9 +22,7 @@ import org.apache.poi.util.LittleEndianOutput; import org.apache.poi.util.StringUtil; /** - * TABLESTYLES (0x088E)
- * - * @author Patrick Cheng + * TABLESTYLES (0x088E) */ public final class TableStylesRecord extends StandardRecord { public static final short sid = 0x088E; diff --git a/src/java/org/apache/poi/hssf/record/TextObjectRecord.java b/src/java/org/apache/poi/hssf/record/TextObjectRecord.java index 56bc7bf8d..148bee315 100644 --- a/src/java/org/apache/poi/hssf/record/TextObjectRecord.java +++ b/src/java/org/apache/poi/hssf/record/TextObjectRecord.java @@ -30,9 +30,7 @@ import org.apache.poi.util.HexDump; * The TXO record (0x01B6) is used to define the properties of a text box. It is * followed by two or more continue records unless there is no actual text. The * first continue records contain the text data and the last continue record - * contains the formatting runs.

- * - * @author Glen Stampoultzis (glens at apache.org) + * contains the formatting runs. */ public final class TextObjectRecord extends ContinuableRecord { public final static short sid = 0x01B6; diff --git a/src/java/org/apache/poi/hssf/record/TopMarginRecord.java b/src/java/org/apache/poi/hssf/record/TopMarginRecord.java index 750ebf0ed..2dfa32b46 100644 --- a/src/java/org/apache/poi/hssf/record/TopMarginRecord.java +++ b/src/java/org/apache/poi/hssf/record/TopMarginRecord.java @@ -20,9 +20,7 @@ package org.apache.poi.hssf.record; import org.apache.poi.util.*; /** - * Record for the top margin.

- * - * @author Shawn Laubach (slaubach at apache dot org) + * Record for the top margin. */ public final class TopMarginRecord extends StandardRecord implements Margin { public final static short sid = 0x28; diff --git a/src/java/org/apache/poi/hssf/record/UnknownRecord.java b/src/java/org/apache/poi/hssf/record/UnknownRecord.java index 8ab1fb479..59bab98f2 100644 --- a/src/java/org/apache/poi/hssf/record/UnknownRecord.java +++ b/src/java/org/apache/poi/hssf/record/UnknownRecord.java @@ -24,14 +24,11 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Unknown Record (for debugging)

+ * Title: Unknown Record (for debugging)

* Description: Unknown record just tells you the sid so you can figure out * what records you are missing. Also helps us read/modify sheets we - * don't know all the records to. (HSSF leaves these alone!)

- * Company: SuperLink Software, Inc.

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author Jason Height (jheight at chariot dot net dot au) - * @author Glen Stampoultzis (glens at apache.org) + * don't know all the records to. (HSSF leaves these alone!)

+ * Company: SuperLink Software, Inc. */ public final class UnknownRecord extends StandardRecord { @@ -40,7 +37,7 @@ public final class UnknownRecord extends StandardRecord { */ /** * seems to be part of the {@link PageSettingsBlock}. Not interpreted by POI. - * The name 'PRINTSIZE' was taken from OOO source.
+ * The name 'PRINTSIZE' was taken from OOO source.

* The few POI test samples with this record have data { 0x03, 0x00 }. */ public static final int PRINTSIZE_0033 = 0x0033; diff --git a/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java b/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java index f1c1e3044..19fdf35f0 100644 --- a/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java +++ b/src/java/org/apache/poi/hssf/record/UseSelFSRecord.java @@ -23,11 +23,10 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: USESELFS (0x0160) - Use Natural Language Formulas Flag

+ * Title: USESELFS (0x0160) - Use Natural Language Formulas Flag

* Description: Tells the GUI if this was written by something that can use - * "natural language" formulas. HSSF can't.

- * REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) + * "natural language" formulas. HSSF can't.

+ * REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class UseSelFSRecord extends StandardRecord { public final static short sid = 0x0160; diff --git a/src/java/org/apache/poi/hssf/record/VerticalPageBreakRecord.java b/src/java/org/apache/poi/hssf/record/VerticalPageBreakRecord.java index 399a96a46..f15baf6ff 100644 --- a/src/java/org/apache/poi/hssf/record/VerticalPageBreakRecord.java +++ b/src/java/org/apache/poi/hssf/record/VerticalPageBreakRecord.java @@ -20,10 +20,9 @@ package org.apache.poi.hssf.record; import java.util.Iterator; /** - * VerticalPageBreak (0x001A) record that stores page breaks at columns

+ * VerticalPageBreak (0x001A) record that stores page breaks at columns * * @see PageBreakRecord - * @author Danny Mui (dmui at apache dot org) */ public final class VerticalPageBreakRecord extends PageBreakRecord { diff --git a/src/java/org/apache/poi/hssf/record/WSBoolRecord.java b/src/java/org/apache/poi/hssf/record/WSBoolRecord.java index 97bca48c3..78185c1df 100644 --- a/src/java/org/apache/poi/hssf/record/WSBoolRecord.java +++ b/src/java/org/apache/poi/hssf/record/WSBoolRecord.java @@ -22,13 +22,10 @@ import org.apache.poi.util.BitFieldFactory; import org.apache.poi.util.LittleEndianOutput; /** - * Title: WSBOOL (0x0081) (called SHEETPR in OOO doc)

+ * Title: WSBOOL (0x0081) (called SHEETPR in OOO doc)

* Description: stores workbook settings (aka its a big "everything we didn't - * put somewhere else")

- * REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

- * @author Andrew C. Oliver (acoliver at apache dot org) - * @author Glen Stampoultzis (gstamp@iprimus.com.au) - * @author Jason Height (jheight at chariot dot net dot au) + * put somewhere else")

+ * REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class WSBoolRecord extends StandardRecord { public final static short sid = 0x0081; diff --git a/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java b/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java index 7d0a4bc02..a360bc4b0 100644 --- a/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java +++ b/src/java/org/apache/poi/hssf/record/WindowProtectRecord.java @@ -23,9 +23,9 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * Title: Window Protect Record (0x0019)

- * Description: flags whether workbook windows are protected

- * REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

+ * Title: Window Protect Record (0x0019)

+ * Description: flags whether workbook windows are protected

+ * REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) */ public final class WindowProtectRecord extends StandardRecord { public final static short sid = 0x0019; diff --git a/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java b/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java index d62a15017..e8c4a6f92 100644 --- a/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java +++ b/src/java/org/apache/poi/hssf/record/WriteAccessRecord.java @@ -24,13 +24,12 @@ import org.apache.poi.util.LittleEndianOutput; import org.apache.poi.util.StringUtil; /** - * Title: Write Access Record (0x005C)

+ * Title: Write Access Record (0x005C)

* * Description: Stores the username of that who owns the spreadsheet generator (on unix the user's - * login, on Windoze its the name you typed when you installed the thing) - *

+ * login, on Windoze its the name you typed when you installed the thing)

+ * * REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) - *

*/ public final class WriteAccessRecord extends StandardRecord { public final static short sid = 0x005C; diff --git a/src/java/org/apache/poi/hssf/record/aggregates/ChartSubstreamRecordAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/ChartSubstreamRecordAggregate.java index 335381308..5df1993e4 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/ChartSubstreamRecordAggregate.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/ChartSubstreamRecordAggregate.java @@ -24,10 +24,8 @@ import org.apache.poi.hssf.model.RecordStream; import org.apache.poi.hssf.record.*; /** - * Manages the all the records associated with a chart sub-stream.
+ * Manages the all the records associated with a chart sub-stream.

* Includes the initial {@link BOFRecord} and final {@link EOFRecord}. - * - * @author Josh Micich */ public final class ChartSubstreamRecordAggregate extends RecordAggregate { diff --git a/src/java/org/apache/poi/hssf/record/aggregates/ConditionalFormattingTable.java b/src/java/org/apache/poi/hssf/record/aggregates/ConditionalFormattingTable.java index e4721ca33..93bae37d9 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/ConditionalFormattingTable.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/ConditionalFormattingTable.java @@ -26,7 +26,7 @@ import org.apache.poi.hssf.record.CFHeaderRecord; import org.apache.poi.ss.formula.FormulaShifter; /** - * Holds all the conditional formatting for a workbook sheet.

+ * Holds all the conditional formatting for a workbook sheet.

* * See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table' */ diff --git a/src/java/org/apache/poi/hssf/record/aggregates/CustomViewSettingsRecordAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/CustomViewSettingsRecordAggregate.java index 168f04f1d..7018eec63 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/CustomViewSettingsRecordAggregate.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/CustomViewSettingsRecordAggregate.java @@ -24,10 +24,8 @@ import org.apache.poi.hssf.model.RecordStream; import org.apache.poi.hssf.record.*; /** - * Manages the all the records associated with a 'Custom View Settings' sub-stream.
+ * Manages the all the records associated with a 'Custom View Settings' sub-stream.

* Includes the initial USERSVIEWBEGIN(0x01AA) and final USERSVIEWEND(0x01AB). - * - * @author Josh Micich */ public final class CustomViewSettingsRecordAggregate extends RecordAggregate { diff --git a/src/java/org/apache/poi/hssf/record/aggregates/DataValidityTable.java b/src/java/org/apache/poi/hssf/record/aggregates/DataValidityTable.java index ff5b9604b..a4bb38ada 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/DataValidityTable.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/DataValidityTable.java @@ -25,9 +25,8 @@ import org.apache.poi.hssf.record.DVALRecord; import org.apache.poi.hssf.record.DVRecord; /** - * Manages the DVALRecord and DVRecords for a single sheet
+ * Manages the DVALRecord and DVRecords for a single sheet

* See OOO excelfileformat.pdf section 4.14 - * @author Josh Micich */ public final class DataValidityTable extends RecordAggregate { diff --git a/src/java/org/apache/poi/hssf/record/aggregates/PageSettingsBlock.java b/src/java/org/apache/poi/hssf/record/aggregates/PageSettingsBlock.java index c183b5070..350617972 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/PageSettingsBlock.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/PageSettingsBlock.java @@ -29,11 +29,9 @@ import org.apache.poi.hssf.record.*; import org.apache.poi.util.HexDump; /** - * Groups the page settings records for a worksheet.

+ * Groups the page settings records for a worksheet.

* * See OOO excelfileformat.pdf sec 4.4 'Page Settings Block' - * - * @author Josh Micich */ public final class PageSettingsBlock extends RecordAggregate { diff --git a/src/ooxml/java/org/apache/poi/POIXMLDocumentPart.java b/src/ooxml/java/org/apache/poi/POIXMLDocumentPart.java index d142b4a79..e98c5b0cf 100644 --- a/src/ooxml/java/org/apache/poi/POIXMLDocumentPart.java +++ b/src/ooxml/java/org/apache/poi/POIXMLDocumentPart.java @@ -405,6 +405,7 @@ public class POIXMLDocumentPart { * @param removeUnusedParts * true, if the part shall be removed from the package if not * needed any longer. + * @return true, if the relation was removed */ protected final boolean removeRelation(POIXMLDocumentPart part, boolean removeUnusedParts){ String id = getRelationId(part); @@ -454,7 +455,7 @@ public class POIXMLDocumentPart { * Sub-classes should override and add logic to marshal the "model" into Ooxml4J. * * For example, the code saving a generic XML entry may look as follows: - * 


+     * 
      * protected void commit() throws IOException {
      *   PackagePart part = getPackagePart();
      *   OutputStream out = part.getOutputStream();
@@ -462,8 +463,9 @@ public class POIXMLDocumentPart {
      *   bean.save(out, DEFAULT_XML_OPTIONS);
      *   out.close();
      * }
-     *  

-     *
+     *
+ * + * @throws IOException a subclass may throw an IOException if the changes can't be committed */ protected void commit() throws IOException { @@ -474,6 +476,8 @@ public class POIXMLDocumentPart { * Recursively fires {@link #commit()} for each package part * * @param alreadySaved context set containing already visited nodes + * + * @throws IOException a related part may throw an IOException if the changes can't be saved */ protected final void onSave(Set alreadySaved) throws IOException{ // this usually clears out previous content in the part... @@ -581,6 +585,8 @@ public class POIXMLDocumentPart { * * @param factory the factory object that creates POIXMLFactory instances * @param context context map containing already visited noted keyed by targetURI + * + * @throws OpenXML4JException thrown when a related part can't be read */ protected void read(POIXMLFactory factory, Map context) throws OpenXML4JException { PackagePart pp = getPackagePart(); @@ -637,7 +643,7 @@ public class POIXMLDocumentPart { * * @param rel The relationship * @return The target part - * @throws InvalidFormatException + * @throws InvalidFormatException thrown if the related part has is erroneous */ protected PackagePart getTargetPart(PackageRelationship rel) throws InvalidFormatException { return getPackagePart().getRelatedPart(rel); @@ -646,6 +652,8 @@ public class POIXMLDocumentPart { /** * Fired when a new package part is created + * + * @throws IOException a subclass may throw an IOException on document creation */ protected void onDocumentCreate() throws IOException { @@ -653,6 +661,8 @@ public class POIXMLDocumentPart { /** * Fired when a package part is read + * + * @throws IOException a subclass may throw an IOException when a document is read */ protected void onDocumentRead() throws IOException { @@ -660,6 +670,8 @@ public class POIXMLDocumentPart { /** * Fired when a package part is about to be removed from the package + * + * @throws IOException a subclass may throw an IOException when a document is removed */ protected void onDocumentRemove() throws IOException { @@ -670,6 +682,10 @@ public class POIXMLDocumentPart { *

* This method only exists to allow access to protected {@link POIXMLDocumentPart#onDocumentRead()} * from {@link org.apache.poi.xwpf.usermodel.XWPFDocument} without reflection. It should be removed. + * + * @param part the part which is to be read + * + * @throws IOException if the part can't be read */ @Internal @Deprecated public static void _invokeOnDocumentRead(POIXMLDocumentPart part) throws IOException { diff --git a/src/ooxml/java/org/apache/poi/POIXMLFactory.java b/src/ooxml/java/org/apache/poi/POIXMLFactory.java index c0457e43f..aabe964ae 100644 --- a/src/ooxml/java/org/apache/poi/POIXMLFactory.java +++ b/src/ooxml/java/org/apache/poi/POIXMLFactory.java @@ -66,6 +66,17 @@ public abstract class POIXMLFactory { /** * Need to delegate instantiation to sub class because of constructor visibility + * + * @param cls the document class to be instantiated + * @param classes the classes of the constructor arguments + * @param values the values of the constructor arguments + * @return the new document / part + * @throws SecurityException thrown if the object can't be instantiated + * @throws NoSuchMethodException thrown if there is no constructor found for the given arguments + * @throws InstantiationException thrown if the object can't be instantiated + * @throws IllegalAccessException thrown if the object can't be instantiated + * @throws InvocationTargetException thrown if the object can't be instantiated + * * @since POI 3.14-Beta1 */ protected abstract POIXMLDocumentPart createDocumentPart @@ -75,6 +86,7 @@ public abstract class POIXMLFactory { /** * returns the descriptor for the given relationship type * + * @param relationshipType the relationship type of the descriptor * @return the descriptor or null if type is unknown * * @since POI 3.14-Beta1 @@ -116,6 +128,13 @@ public abstract class POIXMLFactory { /** * Retrieves the package relationship of the child part within the parent * + * @param parent the parent to search for the part + * @param part the part to look for + * + * @return the relationship + * + * @throws POIXMLException if the relations are erroneous or the part is not related + * * @since POI 3.14-Beta1 */ protected PackageRelationship getPackageRelationship(POIXMLDocumentPart parent, PackagePart part) { diff --git a/src/ooxml/java/org/apache/poi/POIXMLProperties.java b/src/ooxml/java/org/apache/poi/POIXMLProperties.java index 3be94d29d..f55788de1 100644 --- a/src/ooxml/java/org/apache/poi/POIXMLProperties.java +++ b/src/ooxml/java/org/apache/poi/POIXMLProperties.java @@ -97,6 +97,8 @@ public class POIXMLProperties { /** * Returns the core document properties + * + * @return the core document properties */ public CoreProperties getCoreProperties() { return core; @@ -104,6 +106,8 @@ public class POIXMLProperties { /** * Returns the extended document properties + * + * @return the extended document properties */ public ExtendedProperties getExtendedProperties() { return ext; @@ -111,6 +115,8 @@ public class POIXMLProperties { /** * Returns the custom document properties + * + * @return the custom document properties */ public CustomProperties getCustomProperties() { return cust; @@ -118,6 +124,9 @@ public class POIXMLProperties { /** * Commit changes to the underlying OPC package + * + * @throws IOException if the properties can't be saved + * @throws POIXMLException if the properties are erroneous */ public void commit() throws IOException{ @@ -426,6 +435,9 @@ public class POIXMLProperties { /** * Add a new string property + * + * @param name the property name + * @param value the property value * * @throws IllegalArgumentException if a property with this name already exists */ @@ -437,6 +449,9 @@ public class POIXMLProperties { /** * Add a new double property * + * @param name the property name + * @param value the property value + * * @throws IllegalArgumentException if a property with this name already exists */ public void addProperty(String name, double value){ @@ -447,6 +462,9 @@ public class POIXMLProperties { /** * Add a new integer property * + * @param name the property name + * @param value the property value + * * @throws IllegalArgumentException if a property with this name already exists */ public void addProperty(String name, int value){ @@ -457,6 +475,9 @@ public class POIXMLProperties { /** * Add a new boolean property * + * @param name the property name + * @param value the property value + * * @throws IllegalArgumentException if a property with this name already exists */ public void addProperty(String name, boolean value){ @@ -498,6 +519,8 @@ public class POIXMLProperties { * appropriate value for it. * * @param name the name of the property to fetch + * + * @return the custom property with this name, or null if none exists */ public CTProperty getProperty(String name) { for(CTProperty p : props.getProperties().getPropertyArray()){