diff --git a/src/examples/src/org/apache/poi/hssf/usermodel/examples/HSSFReadWrite.java b/src/examples/src/org/apache/poi/hssf/usermodel/examples/HSSFReadWrite.java
index 1f56f7ec5..2393b1812 100644
--- a/src/examples/src/org/apache/poi/hssf/usermodel/examples/HSSFReadWrite.java
+++ b/src/examples/src/org/apache/poi/hssf/usermodel/examples/HSSFReadWrite.java
@@ -140,15 +140,15 @@ public final class HSSFReadWrite {
* Method main
*
* Given 1 argument takes that as the filename, inputs it and dumps the
- * cell values/types out to sys.out.
+ * cell values/types out to sys.out.
*
* given 2 arguments where the second argument is the word "write" and the
* first is the filename - writes out a sample (test) spreadsheet
- * see {@link HSSFReadWrite#testCreateSampleSheet(String)}.
+ * see {@link HSSFReadWrite#testCreateSampleSheet(String)}.
*
* given 2 arguments where the first is an input filename and the second
* an output filename (not write), attempts to fully read in the
- * spreadsheet and fully write it out.
+ * spreadsheet and fully write it out.
*
* given 3 arguments where the first is an input filename and the second an
* output filename (not write) and the third is "modify1", attempts to read in the
diff --git a/src/examples/src/org/apache/poi/hssf/view/SVSheetTable.java b/src/examples/src/org/apache/poi/hssf/view/SVSheetTable.java
index c9e209087..30ce49f8e 100644
--- a/src/examples/src/org/apache/poi/hssf/view/SVSheetTable.java
+++ b/src/examples/src/org/apache/poi/hssf/view/SVSheetTable.java
@@ -64,11 +64,11 @@ public class SVSheetTable extends JTable {
/**
* This field is the magic number to convert from a Character width to a java
* pixel width.
- *
* When the "normal" font size in a workbook changes, this effects all of the * heights and widths. Unfortunately there is no way to retrieve this * information, hence the MAGIC number. - *
+ ** This number may only work for the normal style font size of Arial size 10. */ private static final int magicCharFactor = 7; diff --git a/src/examples/src/org/apache/poi/hssf/view/brush/PendingPaintings.java b/src/examples/src/org/apache/poi/hssf/view/brush/PendingPaintings.java index 3b95c05ac..a8b3849dc 100644 --- a/src/examples/src/org/apache/poi/hssf/view/brush/PendingPaintings.java +++ b/src/examples/src/org/apache/poi/hssf/view/brush/PendingPaintings.java @@ -29,7 +29,7 @@ import java.util.List; * initial paint of the component, and then executed at the appropriate time, * such as at the end of the containing object's {@link * JComponent#paintChildren(Graphics)} method. - *
+ ** It is up to the parent component to invoke the {@link #paint(Graphics2D)} * method of this objet at that appropriate time. * @@ -153,7 +153,7 @@ public class PendingPaintings { * is retrieved from the first object found that has a {@link * #PENDING_PAINTINGS} client property, starting with this component and * looking up its ancestors (parent, parent's parent, etc.) - *
+ ** This allows any descendant of a component that has a {@link * PendingPaintings} property to add its own pending paintings. * diff --git a/src/examples/src/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java b/src/examples/src/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java index bd537c1d1..09ac0ed2c 100644 --- a/src/examples/src/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java +++ b/src/examples/src/org/apache/poi/xssf/eventusermodel/XLSX2CSV.java @@ -46,7 +46,7 @@ import org.xml.sax.XMLReader; * org.apache.poi.hssf.eventusermodel.examples. * As with the HSSF version, this tries to spot missing * rows and cells, and output empty entries for them. - *
+ ** Data sheets are read using a SAX parser to keep the * memory footprint relatively small, so this should be * able to read enormous workbooks. The styles table and @@ -55,7 +55,7 @@ import org.xml.sax.XMLReader; * (read-only) class is used for the shared string table * because the standard POI SharedStringsTable grows very * quickly with the number of unique strings. - *
+ ** For a more advanced implementation of SAX event parsing * of XLSX files, see {@link XSSFEventBasedExcelExtractor} * and {@link XSSFSheetXMLHandler}. Note that for many cases, diff --git a/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java b/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java index 77e04a7ef..4b1641b97 100644 --- a/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java +++ b/src/examples/src/org/apache/poi/xwpf/usermodel/examples/UpdateEmbeddedDoc.java @@ -144,14 +144,14 @@ public class UpdateEmbeddedDoc { * Called to test whether or not the embedded workbook was correctly * updated. This method simply recovers the first cell from the first row * of the first workbook and tests the value it contains. - *
+ ** Note that execution will not continue up to the assertion as the * embedded workbook is now corrupted and causes an IllegalArgumentException * with the following message - *
+ ** java.lang.IllegalArgumentException: Your InputStream was neither an * OLE2 stream, nor an OOXML stream - *
+ ** to be thrown when the WorkbookFactory.createWorkbook(InputStream) method * is executed. * diff --git a/src/excelant/testcases/org/apache/poi/ss/excelant/BuildFileTest.java b/src/excelant/testcases/org/apache/poi/ss/excelant/BuildFileTest.java index 2e0feae80..2a4d71498 100644 --- a/src/excelant/testcases/org/apache/poi/ss/excelant/BuildFileTest.java +++ b/src/excelant/testcases/org/apache/poi/ss/excelant/BuildFileTest.java @@ -37,7 +37,7 @@ import org.apache.tools.ant.ProjectHelper; /** * A BuildFileTest is a TestCase which executes targets from an Ant buildfile * for testing. - *
+ ** This class provides a number of utility methods for particular build file * tests which extend this class. * @@ -73,7 +73,7 @@ public abstract class BuildFileTest extends TestCase { /** * Automatically calls the target called "tearDown" * from the build file tested if it exits. - *
+ ** This allows to use Ant tasks directly in the build file * to clean up after each test. Note that no "setUp" target * is automatically called, since it's trivial to have a @@ -215,7 +215,7 @@ public abstract class BuildFileTest extends TestCase { /** * Gets the log the BuildFileTest object. - *
+ *
* Only valid if configureProject() has been called.
*
* @return The log value
diff --git a/src/java/org/apache/poi/hssf/model/InternalSheet.java b/src/java/org/apache/poi/hssf/model/InternalSheet.java
index 35723ae1b..397c1f6e3 100644
--- a/src/java/org/apache/poi/hssf/model/InternalSheet.java
+++ b/src/java/org/apache/poi/hssf/model/InternalSheet.java
@@ -75,7 +75,7 @@ public final class InternalSheet {
private PageSettingsBlock _psBlock;
/**
- * 'Worksheet Protection Block'
+ * 'Worksheet Protection Block'
* Aggregate object is always present, but possibly empty.
*/
private final WorksheetProtectionBlock _protectionBlock = new WorksheetProtectionBlock();
diff --git a/src/java/org/apache/poi/hssf/model/LinkTable.java b/src/java/org/apache/poi/hssf/model/LinkTable.java
index cc4025838..3e12384e9 100644
--- a/src/java/org/apache/poi/hssf/model/LinkTable.java
+++ b/src/java/org/apache/poi/hssf/model/LinkTable.java
@@ -40,21 +40,21 @@ import org.apache.poi.ss.formula.ptg.Ref3DPtg;
import org.apache.poi.ss.usermodel.Workbook;
/**
- * Link Table (OOO pdf reference: 4.10.3 )
* * The main data of all types of references is stored in the Link Table inside the Workbook Globals * Substream (4.2.5). The Link Table itself is optional and occurs only if there are any * references in the document. - *
+ ** * In BIFF8 the Link Table consists of *
* each consisting of *
* each consisting of *
*
* See OOO excelfileformat.pdf sec. 4.2.5 'Record Order in a BIFF8 Workbook Stream'
*/
diff --git a/src/java/org/apache/poi/hssf/record/DConRefRecord.java b/src/java/org/apache/poi/hssf/record/DConRefRecord.java
index 809506b28..23bbdda11 100644
--- a/src/java/org/apache/poi/hssf/record/DConRefRecord.java
+++ b/src/java/org/apache/poi/hssf/record/DConRefRecord.java
@@ -91,12 +91,12 @@ public class DConRefRecord extends StandardRecord
/**
* The link's path string. This is the rgb
field of a
* XLUnicodeStringNoCch
. Therefore it will contain at least one leading special
- * character (0x01 or 0x02) and probably other ones.
* @see * DConFile [MS-XLS s. 2.5.77] and * * VirtualPath [MS-XLS s. 2.5.69] - *
+ *
*/
private byte[] path;
/**
diff --git a/src/java/org/apache/poi/hssf/record/ExternalNameRecord.java b/src/java/org/apache/poi/hssf/record/ExternalNameRecord.java
index 00603810c..ab76a43d8 100644
--- a/src/java/org/apache/poi/hssf/record/ExternalNameRecord.java
+++ b/src/java/org/apache/poi/hssf/record/ExternalNameRecord.java
@@ -47,7 +47,7 @@ public final class ExternalNameRecord extends StandardRecord {
/**
* 'rgoper' / 'Last received results of the DDE link'
- * (seems to be only applicable to DDE links)
+ * (seems to be only applicable to DDE links)
* Logically this is a 2-D array, which has been flattened into 1-D array here.
*/
private Object[] _ddeValues;
diff --git a/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java b/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java
index 793648792..623065e08 100644
--- a/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java
+++ b/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java
@@ -142,9 +142,9 @@ public final class HyperlinkRecord extends StandardRecord implements Cloneable {
}
/**
- * Read a GUID in standard text form e.g.
+ * Read a GUID in standard text form e.g.
* 13579BDF-0246-8ACE-0123-456789ABCDEF
- *
->
+ *
->
* 0x13579BDF, 0x0246, 0x8ACE 0x0123456789ABCDEF
*/
public static GUID parse(String rep) {
@@ -240,7 +240,7 @@ public final class HyperlinkRecord extends StandardRecord implements Cloneable {
private String _address;
/**
* Text describing a place in document. In Excel UI, this is appended to the
- * address, (after a '#' delimiter).
+ * address, (after a '#' delimiter).
* This field is optional. If present, the {@link #HLINK_PLACE} must be set.
*/
private String _textMark;
diff --git a/src/java/org/apache/poi/hssf/record/NoteRecord.java b/src/java/org/apache/poi/hssf/record/NoteRecord.java
index 1717444a7..f4c81976c 100644
--- a/src/java/org/apache/poi/hssf/record/NoteRecord.java
+++ b/src/java/org/apache/poi/hssf/record/NoteRecord.java
@@ -47,7 +47,7 @@ public final class NoteRecord extends StandardRecord implements Cloneable {
private boolean field_5_hasMultibyte;
private String field_6_author;
/**
- * Saves padding byte value to reduce delta during round-trip serialization.
+ * Saves padding byte value to reduce delta during round-trip serialization.
*
* The documentation is not clear about how padding should work. In any case
* Excel(2007) does something different.
diff --git a/src/java/org/apache/poi/hssf/record/RecordFactory.java b/src/java/org/apache/poi/hssf/record/RecordFactory.java
index 2336999b1..8e994d8dd 100644
--- a/src/java/org/apache/poi/hssf/record/RecordFactory.java
+++ b/src/java/org/apache/poi/hssf/record/RecordFactory.java
@@ -136,7 +136,7 @@ public final class RecordFactory {
private static final Class>[] CONSTRUCTOR_ARGS = { RecordInputStream.class, };
/**
- * contains the classes for all the records we want to parse.
+ * contains the classes for all the records we want to parse.
* Note - this most but not *every* subclass of Record.
*/
@SuppressWarnings("unchecked")
diff --git a/src/java/org/apache/poi/hssf/record/aggregates/FormulaRecordAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/FormulaRecordAggregate.java
index 02a95a55c..ff442f4e6 100644
--- a/src/java/org/apache/poi/hssf/record/aggregates/FormulaRecordAggregate.java
+++ b/src/java/org/apache/poi/hssf/record/aggregates/FormulaRecordAggregate.java
@@ -85,11 +85,11 @@ public final class FormulaRecordAggregate extends RecordAggregate implements Cel
* the {@link Ptg} tokens for the formula. However as it turns out in these
* cases, Excel encodes the unshared {@link Ptg} tokens in the right place (inside the {@link
* FormulaRecord}). So the the only thing that needs to be done is to ignore the erroneous
- * shared formula flag.
+ * shared formula flag.
*
* This method may also be used for setting breakpoints to help diagnose issues regarding the
* abnormally-set 'shared formula' flags.
- * (see TestValueRecordsAggregate.testSpuriousSharedFormulaFlag()).
*/
private static void handleMissingSharedFormulaRecord(FormulaRecord formula) {
// make sure 'unshared' formula is actually available
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 e1d21cf97..73531fe48 100644
--- a/src/java/org/apache/poi/hssf/record/aggregates/PageSettingsBlock.java
+++ b/src/java/org/apache/poi/hssf/record/aggregates/PageSettingsBlock.java
@@ -42,7 +42,7 @@ public final class PageSettingsBlock extends RecordAggregate {
private static final ContinueRecord[] EMPTY_CONTINUE_RECORD_ARRAY = { };
private final Record _pls;
/**
- * holds any continue records found after the PLS record.
+ * holds any continue records found after the PLS record.
* This would not be required if PLS was properly interpreted.
* Currently, PLS is an {@link UnknownRecord} and does not automatically
* include any trailing {@link ContinueRecord}s.
diff --git a/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java b/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java
index 5551639b4..8a9782768 100644
--- a/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java
+++ b/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java
@@ -166,7 +166,7 @@ public final class RowRecordsAggregate extends RecordAggregate {
}
/** Returns the number of row blocks.
- *
The row blocks are goupings of rows that contain the DBCell record * after them */ public int getRowBlockCount() { diff --git a/src/java/org/apache/poi/hssf/record/aggregates/WorksheetProtectionBlock.java b/src/java/org/apache/poi/hssf/record/aggregates/WorksheetProtectionBlock.java index db4f7c8dd..48e84171c 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/WorksheetProtectionBlock.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/WorksheetProtectionBlock.java @@ -28,7 +28,7 @@ import org.apache.poi.util.RecordFormatException; /** * Groups the sheet protection records for a worksheet. - *
+ ** * See OOO excelfileformat.pdf sec 4.18.2 'Sheet Protection in a Workbook * (BIFF5-BIFF8)' @@ -124,14 +124,14 @@ public final class WorksheetProtectionBlock extends RecordAggregate { * This method reads {@link WorksheetProtectionBlock} records from the supplied RecordStream * until the first non-WorksheetProtectionBlock record is encountered. As each record is read, * it is incorporated into this WorksheetProtectionBlock. - *
+ ** As per the OOO documentation, the protection block records can be expected to be written * together (with no intervening records), but earlier versions of POI (prior to Jun 2009) * didn't do this. Workbooks with sheet protection created by those earlier POI versions * seemed to be valid (Excel opens them OK). So PO allows continues to support reading of files * with non continuous worksheet protection blocks. * - *
+ ** Note - when POI writes out this WorksheetProtectionBlock, the records will always be * written in one consolidated block (in the standard ordering) regardless of how scattered the * records were when they were originally read. diff --git a/src/java/org/apache/poi/hssf/record/chart/AreaFormatRecord.java b/src/java/org/apache/poi/hssf/record/chart/AreaFormatRecord.java index 229743ebd..9c8ba326c 100644 --- a/src/java/org/apache/poi/hssf/record/chart/AreaFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/chart/AreaFormatRecord.java @@ -25,7 +25,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * The area format record is used to define the colours and patterns for an area.
+ * The area format record is used to define the colours and patterns for an area.* * @author Glen Stampoultzis (glens at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/chart/AreaRecord.java b/src/java/org/apache/poi/hssf/record/chart/AreaRecord.java index 0bc901d0c..4e15d22ba 100644 --- a/src/java/org/apache/poi/hssf/record/chart/AreaRecord.java +++ b/src/java/org/apache/poi/hssf/record/chart/AreaRecord.java @@ -25,7 +25,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * The area record is used to define a area chart.
+ * The area record is used to define a area chart.* * @author Glen Stampoultzis (glens at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/chart/AxisLineFormatRecord.java b/src/java/org/apache/poi/hssf/record/chart/AxisLineFormatRecord.java index 92b0b6af2..af9c94382 100644 --- a/src/java/org/apache/poi/hssf/record/chart/AxisLineFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/chart/AxisLineFormatRecord.java @@ -23,7 +23,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * The axis line format record defines the axis type details.
+ * The axis line format record defines the axis type details.* * @author Glen Stampoultzis (glens at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/chart/AxisOptionsRecord.java b/src/java/org/apache/poi/hssf/record/chart/AxisOptionsRecord.java index e6c4768c8..463340616 100644 --- a/src/java/org/apache/poi/hssf/record/chart/AxisOptionsRecord.java +++ b/src/java/org/apache/poi/hssf/record/chart/AxisOptionsRecord.java @@ -25,7 +25,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * The axis options record provides unit information and other various tidbits about the axis.
+ * The axis options record provides unit information and other various tidbits about the axis.* * @author Andrew C. Oliver(acoliver at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/chart/AxisParentRecord.java b/src/java/org/apache/poi/hssf/record/chart/AxisParentRecord.java index 8cf8fdb09..b809d227e 100644 --- a/src/java/org/apache/poi/hssf/record/chart/AxisParentRecord.java +++ b/src/java/org/apache/poi/hssf/record/chart/AxisParentRecord.java @@ -23,7 +23,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * The axis size and location
+ * The axis size and location* * @author Glen Stampoultzis (glens at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/chart/AxisRecord.java b/src/java/org/apache/poi/hssf/record/chart/AxisRecord.java index 42aefb4a8..3c363eab3 100644 --- a/src/java/org/apache/poi/hssf/record/chart/AxisRecord.java +++ b/src/java/org/apache/poi/hssf/record/chart/AxisRecord.java @@ -23,7 +23,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * The axis record defines the type of an axis.
+ * The axis record defines the type of an axis.* * @author Glen Stampoultzis (glens at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/chart/AxisUsedRecord.java b/src/java/org/apache/poi/hssf/record/chart/AxisUsedRecord.java index baca15b57..1725059e3 100644 --- a/src/java/org/apache/poi/hssf/record/chart/AxisUsedRecord.java +++ b/src/java/org/apache/poi/hssf/record/chart/AxisUsedRecord.java @@ -23,7 +23,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * The number of axes used on a chart.
+ * The number of axes used on a chart.* * @author Glen Stampoultzis (glens at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/chart/BarRecord.java b/src/java/org/apache/poi/hssf/record/chart/BarRecord.java index 72d418cb7..ad53d145d 100644 --- a/src/java/org/apache/poi/hssf/record/chart/BarRecord.java +++ b/src/java/org/apache/poi/hssf/record/chart/BarRecord.java @@ -25,7 +25,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * The bar record is used to define a bar chart.
+ * The bar record is used to define a bar chart.
*
* @author Glen Stampoultzis (glens at apache.org)
*/
diff --git a/src/java/org/apache/poi/hssf/record/chart/CatLabRecord.java b/src/java/org/apache/poi/hssf/record/chart/CatLabRecord.java
index 92f3b555e..22c159635 100644
--- a/src/java/org/apache/poi/hssf/record/chart/CatLabRecord.java
+++ b/src/java/org/apache/poi/hssf/record/chart/CatLabRecord.java
@@ -23,7 +23,7 @@ import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndianOutput;
/**
- * CATLAB - Category Labels (0x0856)
+ * CATLAB - Category Labels (0x0856)
*
* @author Patrick Cheng
*/
diff --git a/src/java/org/apache/poi/hssf/record/chart/CategorySeriesAxisRecord.java b/src/java/org/apache/poi/hssf/record/chart/CategorySeriesAxisRecord.java
index 6e8216a13..45e1c6572 100644
--- a/src/java/org/apache/poi/hssf/record/chart/CategorySeriesAxisRecord.java
+++ b/src/java/org/apache/poi/hssf/record/chart/CategorySeriesAxisRecord.java
@@ -25,7 +25,7 @@ import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndianOutput;
/**
- * This record refers to a category or series axis and is used to specify label/tickmark frequency.
*
* @author Glen Stampoultzis (glens at apache.org)
*/
diff --git a/src/java/org/apache/poi/hssf/record/chart/ChartEndBlockRecord.java b/src/java/org/apache/poi/hssf/record/chart/ChartEndBlockRecord.java
index 4354b01c5..04c855818 100644
--- a/src/java/org/apache/poi/hssf/record/chart/ChartEndBlockRecord.java
+++ b/src/java/org/apache/poi/hssf/record/chart/ChartEndBlockRecord.java
@@ -23,7 +23,7 @@ import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndianOutput;
/**
- * ENDBLOCK - Chart Future Record Type End Block (0x0853)
+ * ENDBLOCK - Chart Future Record Type End Block (0x0853)
*
* @author Patrick Cheng
*/
diff --git a/src/java/org/apache/poi/hssf/record/chart/FontIndexRecord.java b/src/java/org/apache/poi/hssf/record/chart/FontIndexRecord.java
index 4faacab13..167e8e07b 100644
--- a/src/java/org/apache/poi/hssf/record/chart/FontIndexRecord.java
+++ b/src/java/org/apache/poi/hssf/record/chart/FontIndexRecord.java
@@ -23,7 +23,7 @@ import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndianOutput;
/**
- * The font index record indexes into the font table for the text record.
* * @author Glen Stampoultzis (glens at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/chart/SeriesLabelsRecord.java b/src/java/org/apache/poi/hssf/record/chart/SeriesLabelsRecord.java index 9fff21af9..27b0914b7 100644 --- a/src/java/org/apache/poi/hssf/record/chart/SeriesLabelsRecord.java +++ b/src/java/org/apache/poi/hssf/record/chart/SeriesLabelsRecord.java @@ -25,7 +25,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * The series label record defines the type of label associated with the data format record.
+ * The series label record defines the type of label associated with the data format record.* * @author Glen Stampoultzis (glens at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/chart/TickRecord.java b/src/java/org/apache/poi/hssf/record/chart/TickRecord.java index 993f5705c..e77b3f3f4 100644 --- a/src/java/org/apache/poi/hssf/record/chart/TickRecord.java +++ b/src/java/org/apache/poi/hssf/record/chart/TickRecord.java @@ -25,7 +25,7 @@ import org.apache.poi.util.HexDump; import org.apache.poi.util.LittleEndianOutput; /** - * The Tick record defines how tick marks and label positioning/formatting
+ * The Tick record defines how tick marks and label positioning/formatting* * @author Andrew C. Oliver(acoliver at apache.org) */ diff --git a/src/java/org/apache/poi/hssf/record/common/UnicodeString.java b/src/java/org/apache/poi/hssf/record/common/UnicodeString.java index 28ee7542c..0bfa6b406 100644 --- a/src/java/org/apache/poi/hssf/record/common/UnicodeString.java +++ b/src/java/org/apache/poi/hssf/record/common/UnicodeString.java @@ -35,11 +35,11 @@ import org.apache.poi.util.POILogger; import org.apache.poi.util.StringUtil; /** - * Title: Unicode String
+ * Title: Unicode String* Description: Unicode String - just standard fields that are in several records. - * It is considered more desirable then repeating it in all of them.
- * This is often called a XLUnicodeRichExtendedString in MS documentation. - * REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) + * It is considered more desirable then repeating it in all of them.+ * This is often called a XLUnicodeRichExtendedString in MS documentation.
+ * REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
* REFERENCE: PG 951 Excel Binary File Format (.xls) Structure Specification v20091214
*/
public class UnicodeString implements Comparable
*
* Usually the caller is calling setCellType() with the intention of calling
* setCellValue(boolean) straight afterwards. This method only exists to give
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFDataFormat.java b/src/java/org/apache/poi/hssf/usermodel/HSSFDataFormat.java
index 23fe8cad7..7c3b636fd 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFDataFormat.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFDataFormat.java
@@ -28,10 +28,10 @@ import org.apache.poi.ss.usermodel.BuiltinFormats;
import org.apache.poi.ss.usermodel.DataFormat;
/**
- * Identifies both built-in and user defined formats within a workbook.
+ * See {@link BuiltinFormats} for a list of supported built-in formats.
*
- * International Formats
*
* For performance reasons, this class keeps a cache of all previously calculated intermediate
* cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFObjectData.java b/src/java/org/apache/poi/hssf/usermodel/HSSFObjectData.java
index 201e65ed5..3909f4140 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFObjectData.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFObjectData.java
@@ -30,7 +30,7 @@ import org.apache.poi.util.HexDump;
/**
* Represents binary object (i.e. OLE) data stored in the file. Eg. A GIF, JPEG etc...
- *
* Right now, 13, july, 2012 can not be created from scratch
*/
public final class HSSFObjectData extends HSSFPicture implements ObjectData {
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFPicture.java b/src/java/org/apache/poi/hssf/usermodel/HSSFPicture.java
index 65cb59d1b..ef66389c5 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFPicture.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFPicture.java
@@ -126,9 +126,9 @@ public class HSSFPicture extends HSSFSimpleShape implements Picture {
* If the default font is changed the resized image can be streched vertically or horizontally.
*
- *
* which gives
* TODO - formulas containing cell references are currently not parsed properly
*
* @param comparisonOperation - a constant value from
@@ -83,7 +83,7 @@ public final class HSSFSheetConditionalFormatting implements SheetConditionalFor
/**
* A factory method allowing to create a conditional formatting rule with a formula.
* TODO - formulas containing cell references are currently not parsed properly
* @param formula - formula for the valued, compared with the cell
*/
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
index a24217077..c2e8fdd58 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
@@ -1061,11 +1061,11 @@ public final class HSSFWorkbook extends POIDocument implements org.apache.poi.ss
}
/**
- * Removes sheet at the given index.
*
* Care must be taken if the removed sheet is the currently active or only selected sheet in
* the workbook. There are a few situations when Excel must have a selection and/or active
- * sheet. (For example when printing - see Bug 40414).
*
* Implements a CellRangeAddress with 8-but column fields.
*/
diff --git a/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java b/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
index 8a14b66d1..5f09b69be 100644
--- a/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
+++ b/src/java/org/apache/poi/poifs/crypt/CryptoFunctions.java
@@ -45,7 +45,7 @@ import org.apache.poi.util.StringUtil;
@Internal
public class CryptoFunctions {
/**
- * 2.3.4.7 ECMA-376 Document Encryption Key Generation (Standard Encryption) 2.3.4.7 ECMA-376 Document Encryption Key Generation (Standard Encryption) The encryption key for ECMA-376 document encryption [ECMA-376] using agile
@@ -133,9 +133,9 @@ public class CryptoFunctions {
* generated by using the following method, where H() is a hash function that MUST be the same as
* specified in section 2.3.4.11 and a plus sign (+) represents concatenation:
*
* Some streams are usable after reaching EOF (typically those that return
*
* Some streams are usable after reaching EOF (typically those that return
*
* Some streams are usable after reaching EOF (typically those that return
*
* Note - the calling class should call the {@link #available()} method to detect end-of-buffer
* and move to the next data block when the current is exhausted.
* For optimisation reasons, no error handling is performed in this class. Thus, mistakes in
* calling code ran may raise ugly exceptions here, like {@link ArrayIndexOutOfBoundsException},
- * etc .
*
* The multi-byte primitive input methods ({@link #readUShortLE()}, {@link #readIntLE()} and
* {@link #readLongLE()}) have corresponding 'spanning read' methods which (when required) perform
diff --git a/src/java/org/apache/poi/ss/format/CellDateFormatter.java b/src/java/org/apache/poi/ss/format/CellDateFormatter.java
index a59fd0c72..4af6d6b4b 100644
--- a/src/java/org/apache/poi/ss/format/CellDateFormatter.java
+++ b/src/java/org/apache/poi/ss/format/CellDateFormatter.java
@@ -222,7 +222,7 @@ public class CellDateFormatter extends CellFormatter {
/**
* {@inheritDoc}
- *
* For a date, this is "mm/d/y".
*/
public void simpleValue(StringBuffer toAppendTo, Object value) {
diff --git a/src/java/org/apache/poi/ss/format/CellElapsedFormatter.java b/src/java/org/apache/poi/ss/format/CellElapsedFormatter.java
index 9a90e8a9e..c0cdb7b90 100644
--- a/src/java/org/apache/poi/ss/format/CellElapsedFormatter.java
+++ b/src/java/org/apache/poi/ss/format/CellElapsedFormatter.java
@@ -211,7 +211,7 @@ public class CellElapsedFormatter extends CellFormatter {
/**
* {@inheritDoc}
- *
* For a date, this is "mm/d/y".
*/
public void simpleValue(StringBuffer toAppendTo, Object value) {
diff --git a/src/java/org/apache/poi/ss/format/CellFormat.java b/src/java/org/apache/poi/ss/format/CellFormat.java
index 8f67164d7..de1bad4bd 100644
--- a/src/java/org/apache/poi/ss/format/CellFormat.java
+++ b/src/java/org/apache/poi/ss/format/CellFormat.java
@@ -43,7 +43,7 @@ import org.apache.poi.util.Removal;
* Format a value according to the standard Excel behavior. This "standard" is
* not explicitly documented by Microsoft, so the behavior is determined by
* experimentation; see the tests.
- *
* An Excel format has up to four parts, separated by semicolons. Each part
* specifies what to do with particular kinds of values, depending on the number
* of parts given:
@@ -75,12 +75,12 @@ import org.apache.poi.util.Removal;
* fourth part (example: text in the cell's usual color, with the text value
* surround by brackets).
*
- *
* A given format part may specify a given Locale, by including something
* like [$$-409] or [$£-809] or [$-40C]. These
* are (currently) largely ignored. You can use {@link DateFormatConverter}
* to look these up into Java Locales if desired.
- *
* In addition to these, there is a general format that is used when no format
* is specified. This formatting is presented by the {@link #GENERAL_FORMAT}
* object.
diff --git a/src/java/org/apache/poi/ss/format/CellFormatPart.java b/src/java/org/apache/poi/ss/format/CellFormatPart.java
index 40cfb4a76..699475760 100644
--- a/src/java/org/apache/poi/ss/format/CellFormatPart.java
+++ b/src/java/org/apache/poi/ss/format/CellFormatPart.java
@@ -35,12 +35,12 @@ import static org.apache.poi.ss.format.CellFormatter.quote;
* Objects of this class represent a single part of a cell format expression.
* Each cell can have up to four of these for positive, zero, negative, and text
* values.
- *
* Each format part can contain a color, a condition, and will always contain a
* format specification. For example "[Red][>=10]#" has a color
* ([Red]), a condition (>=10) and a format specification
* (#).
- *
* This class also contains patterns for matching the subparts of format
* specification. These are used internally, but are made public in case other
* code has use for them.
diff --git a/src/java/org/apache/poi/ss/format/CellNumberFormatter.java b/src/java/org/apache/poi/ss/format/CellNumberFormatter.java
index 9657572e4..2c193fac2 100644
--- a/src/java/org/apache/poi/ss/format/CellNumberFormatter.java
+++ b/src/java/org/apache/poi/ss/format/CellNumberFormatter.java
@@ -583,7 +583,7 @@ public class CellNumberFormatter extends CellFormatter {
* the result is the original format, and that starting from that situation,
* the indexes of the original special characters can be used to place the new
* characters. As just described, this is not true for the exponent's sign.
- *
* So here is how we handle it:
*
* (1) When parsing the format, remove the sign from after the 'e' and put it
@@ -847,7 +847,7 @@ public class CellNumberFormatter extends CellFormatter {
/**
* {@inheritDoc}
- *
* For a number, this is "#" for integer values, and "#.#"
* for floating-point values.
*/
diff --git a/src/java/org/apache/poi/ss/format/CellTextFormatter.java b/src/java/org/apache/poi/ss/format/CellTextFormatter.java
index bde29e2ea..5712bb24a 100644
--- a/src/java/org/apache/poi/ss/format/CellTextFormatter.java
+++ b/src/java/org/apache/poi/ss/format/CellTextFormatter.java
@@ -74,7 +74,7 @@ public class CellTextFormatter extends CellFormatter {
/**
* {@inheritDoc}
- *
* For text, this is just printing the text.
*/
public void simpleValue(StringBuffer toAppendTo, Object value) {
diff --git a/src/java/org/apache/poi/ss/formula/BaseFormulaEvaluator.java b/src/java/org/apache/poi/ss/formula/BaseFormulaEvaluator.java
index 74872de75..43160f3e9 100644
--- a/src/java/org/apache/poi/ss/formula/BaseFormulaEvaluator.java
+++ b/src/java/org/apache/poi/ss/formula/BaseFormulaEvaluator.java
@@ -29,7 +29,7 @@ import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
/**
- * Common functionality across file formats for evaluating formula cells.
*/
public abstract class BaseFormulaEvaluator implements FormulaEvaluator, WorkbookEvaluatorProvider {
protected final WorkbookEvaluator _bookEvaluator;
diff --git a/src/java/org/apache/poi/ss/formula/CellCacheEntry.java b/src/java/org/apache/poi/ss/formula/CellCacheEntry.java
index dbf89e9a5..22db40053 100644
--- a/src/java/org/apache/poi/ss/formula/CellCacheEntry.java
+++ b/src/java/org/apache/poi/ss/formula/CellCacheEntry.java
@@ -26,7 +26,7 @@ import org.apache.poi.ss.formula.eval.ValueEval;
import org.apache.poi.ss.formula.IEvaluationListener.ICacheEntry;
/**
- * Stores the parameters that identify the evaluation of one cell.
*
* For performance reasons, this class keeps a cache of all previously evaluated rules and cells.
* Be sure to call {@link #clearAllCachedFormats()} if any conditional formats are modified, added, or deleted,
* and {@link #clearAllCachedValues()} whenever cell values change.
- *
*
*/
public class ConditionalFormattingEvaluator {
@@ -53,9 +53,9 @@ public class ConditionalFormattingEvaluator {
* All the underlying structures, for both HSSF and XSSF, repeatedly go to the raw bytes/XML for the
* different pieces used in the ConditionalFormatting* structures. That's highly inefficient,
* and can cause significant lag when checking formats for large workbooks.
- *
* Instead we need a cached version that is discarded when definitions change.
- *
* Sheets don't implement equals, and since its an interface,
* there's no guarantee instances won't be recreated on the fly by some implementation.
* So we use sheet name.
@@ -65,9 +65,9 @@ public class ConditionalFormattingEvaluator {
/**
* Evaluating rules for cells in their region(s) is expensive, so we want to cache them,
* and empty/reevaluate the cache when values change.
- *
* Rule lists are in priority order, as evaluated by Excel (smallest priority # for XSSF, definition order for HSSF)
- *
* CellReference implements equals().
*/
private final Map
* TODO: eventually this should work like {@link EvaluationCache#notifyUpdateCell(int, int, EvaluationCell)}
* and only clear values that need recalculation based on the formula dependency tree.
*/
@@ -136,10 +136,10 @@ public class ConditionalFormattingEvaluator {
* This checks all applicable {@link ConditionalFormattingRule}s for the cell's sheet,
* in defined "priority" order, returning the matches if any. This is a property currently
* not exposed from
* Most cells will have zero or one applied rule, but it is possible to define multiple rules
* that apply at the same time to the same cell, thus the List result.
- *
* Note that to properly apply conditional rules, care must be taken to offset the base
* formula by the relative position of the current cell, or the wrong value is checked.
* This is handled by {@link WorkbookEvaluator#evaluate(String, CellReference, CellRangeAddressBase)}.
@@ -171,10 +171,10 @@ public class ConditionalFormattingEvaluator {
* This checks all applicable {@link ConditionalFormattingRule}s for the cell's sheet,
* in defined "priority" order, returning the matches if any. This is a property currently
* not exposed from
* Most cells will have zero or one applied rule, but it is possible to define multiple rules
* that apply at the same time to the same cell, thus the List result.
- *
* Note that to properly apply conditional rules, care must be taken to offset the base
* formula by the relative position of the current cell, or the wrong value is checked.
* This is handled by {@link WorkbookEvaluator#evaluate(String, CellReference, CellRangeAddressBase)}.
@@ -249,9 +249,9 @@ public class ConditionalFormattingEvaluator {
/**
* Conditional formatting rules can apply only to cells in the sheet to which they are attached.
* The POI data model does not have a back-reference to the owning sheet, so it must be passed in separately.
- *
* We could overload this with convenience methods taking a sheet name and sheet index as well.
- *
* @param sheet containing the rule
* @param conditionalFormattingIndex of the {@link ConditionalFormatting} instance in the sheet's array
* @param ruleIndex of the {@link ConditionalFormattingRule} instance within the {@link ConditionalFormatting}
diff --git a/src/java/org/apache/poi/ss/formula/DataValidationEvaluator.java b/src/java/org/apache/poi/ss/formula/DataValidationEvaluator.java
index 94bf9ff68..dd8f0faae 100644
--- a/src/java/org/apache/poi/ss/formula/DataValidationEvaluator.java
+++ b/src/java/org/apache/poi/ss/formula/DataValidationEvaluator.java
@@ -44,12 +44,12 @@ import org.apache.poi.ss.util.CellReference;
import org.apache.poi.ss.util.SheetUtil;
/**
- * Evaluates Data Validation constraints.
*
* For performance reasons, this class keeps a cache of all previously retrieved {@link DataValidation} instances.
* Be sure to call {@link #clearAllCachedValues()} if any workbook validation definitions are
* added, modified, or deleted.
- *
* Changing cell values should be fine, as long as the corresponding {@link WorkbookEvaluator#clearAllCachedResultValues()}
* is called as well.
*
@@ -58,7 +58,7 @@ public class DataValidationEvaluator {
/**
* Expensive to compute, so cache them as they are retrieved.
- *
* Sheets don't implement equals, and since its an interface,
* there's no guarantee instances won't be recreated on the fly by some implementation.
* So we use sheet name.
@@ -157,10 +157,10 @@ public class DataValidationEvaluator {
* If {@link #getValidationForCell(CellReference)} returns an instance, and the
* {@link ValidationType} is {@link ValidationType#LIST}, return the valid
* values, whether they are from a static list or cell range.
- *
* For all other validation types, or no validation at all, this method
* returns null.
- *
* This method could throw an exception if the validation type is not LIST,
* but since this method is mostly useful in UI contexts, null seems the
* easier path.
@@ -214,7 +214,7 @@ public class DataValidationEvaluator {
* Use the validation returned by {@link #getValidationForCell(CellReference)} if you
* want the error display details. This is the validation checked by this
* method, which attempts to replicate Excel's data validation rules.
- *
* Note that to properly apply some validations, care must be taken to
* offset the base validation formula by the relative position of the
* current cell, or the wrong value is checked.
diff --git a/src/java/org/apache/poi/ss/formula/EvaluationCell.java b/src/java/org/apache/poi/ss/formula/EvaluationCell.java
index ecf53ed79..95792add2 100644
--- a/src/java/org/apache/poi/ss/formula/EvaluationCell.java
+++ b/src/java/org/apache/poi/ss/formula/EvaluationCell.java
@@ -21,7 +21,7 @@ import org.apache.poi.ss.usermodel.CellType;
/**
* Abstracts a cell for the purpose of formula evaluation. This interface represents both formula
- * and non-formula cells.
* Having this all combined and cached avoids repeated access calls to the
* underlying structural objects, XSSF CT* objects and HSSF raw byte structures.
* Those objects can be referenced from here. This object will be out of sync if
* anything modifies the referenced structures' evaluation properties.
- *
* The assumption is that consuming applications will read the display properties once and
* create whatever style objects they need, caching those at the application level.
* Thus this class only caches values needed for evaluation, not display.
@@ -225,7 +225,7 @@ public class EvaluationConditionalFormatRule implements Comparable
* HSSF priority is based on definition/persistence order.
*
* @param o
diff --git a/src/java/org/apache/poi/ss/formula/EvaluationName.java b/src/java/org/apache/poi/ss/formula/EvaluationName.java
index 2d1fbf5e2..e43ab76c4 100644
--- a/src/java/org/apache/poi/ss/formula/EvaluationName.java
+++ b/src/java/org/apache/poi/ss/formula/EvaluationName.java
@@ -20,7 +20,7 @@ package org.apache.poi.ss.formula;
import org.apache.poi.ss.formula.ptg.NamePtg;
import org.apache.poi.ss.formula.ptg.Ptg;
/**
- * Abstracts a name record for formula evaluation.
*
* Every successful call to startEvaluate must be followed by a call to endEvaluate (recommended in a finally block) to enable
- * proper tracking of which cells are being evaluated at any point in time.
*
* Assuming a well behaved client, parameters to this method would not be
* required. However, they have been included to assert correct behaviour,
diff --git a/src/java/org/apache/poi/ss/formula/EvaluationWorkbook.java b/src/java/org/apache/poi/ss/formula/EvaluationWorkbook.java
index 2110e5742..2a6aed075 100644
--- a/src/java/org/apache/poi/ss/formula/EvaluationWorkbook.java
+++ b/src/java/org/apache/poi/ss/formula/EvaluationWorkbook.java
@@ -25,7 +25,7 @@ import org.apache.poi.ss.formula.udf.UDFFinder;
import org.apache.poi.util.Internal;
/**
- * Abstracts a workbook for the purpose of formula evaluation.
* For POI internal use only
- *
*/
@Internal
public final class FormulaParser {
diff --git a/src/java/org/apache/poi/ss/formula/FormulaParsingWorkbook.java b/src/java/org/apache/poi/ss/formula/FormulaParsingWorkbook.java
index 7ddcc944c..1d0c275b9 100644
--- a/src/java/org/apache/poi/ss/formula/FormulaParsingWorkbook.java
+++ b/src/java/org/apache/poi/ss/formula/FormulaParsingWorkbook.java
@@ -25,7 +25,7 @@ import org.apache.poi.ss.util.AreaReference;
import org.apache.poi.ss.util.CellReference;
/**
- * Abstracts a workbook for the purpose of formula parsing.
*
* The final operand class chosen for each token depends on the formula type and the token's place
* in the formula. If POI gets the operand class wrong, Excel may interpret the formula
* incorrectly. This condition is typically manifested as a formula cell that displays as '#VALUE!',
- * but resolves correctly when the user presses F2, enter.
*
* The logic implemented here was partially inspired by the description in
* "OpenOffice.org's Documentation of the Microsoft Excel File Format". The model presented there
* seems to be inconsistent with observed Excel behaviour (These differences have not been fully
* investigated). The implementation in this class has been heavily modified in order to satisfy
- * concrete examples of how Excel performs the same logic (see TestRVA).
*
* Hopefully, as additional important test cases are identified and added to the test suite,
* patterns might become more obvious in this code and allow for simplification.
diff --git a/src/java/org/apache/poi/ss/formula/SheetNameFormatter.java b/src/java/org/apache/poi/ss/formula/SheetNameFormatter.java
index 479704887..7f4f5b86c 100644
--- a/src/java/org/apache/poi/ss/formula/SheetNameFormatter.java
+++ b/src/java/org/apache/poi/ss/formula/SheetNameFormatter.java
@@ -162,7 +162,7 @@ public final class SheetNameFormatter {
/**
* Used to decide whether sheet names like 'AB123' need delimiting due to the fact that they
* look like cell references.
- *
* This code is currently being used for translating formulas represented with
* For better or worse this implementation attempts to replicate Excel's formula renderer.
* Excel uses range checking on the apparent 'row' and 'column' components. Note however that
* the maximum sheet size varies across versions.
@@ -190,7 +190,7 @@ public final class SheetNameFormatter {
/**
* Note - this method assumes the specified rawSheetName has only letters and digits. It
* cannot be used to match absolute or range references (using the dollar or colon char).
- *
* Some notable cases:
*
*
* For performance reasons, this class keeps a cache of all previously calculated intermediate
* cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between
- * calls to evaluate~ methods on this class.
*
- * Syntax
*
- * Syntax
*
* @author Yegor Kozlov
*/
diff --git a/src/java/org/apache/poi/ss/formula/atp/NetworkdaysFunction.java b/src/java/org/apache/poi/ss/formula/atp/NetworkdaysFunction.java
index 95e054864..e01ba8479 100644
--- a/src/java/org/apache/poi/ss/formula/atp/NetworkdaysFunction.java
+++ b/src/java/org/apache/poi/ss/formula/atp/NetworkdaysFunction.java
@@ -26,13 +26,13 @@ import org.apache.poi.ss.formula.eval.ValueEval;
import org.apache.poi.ss.formula.functions.FreeRefFunction;
/**
- * Implementation of Excel 'Analysis ToolPak' function NETWORKDAYS()
+ * Syntax
*
* @author jfaenomoto@gmail.com
*/
diff --git a/src/java/org/apache/poi/ss/formula/atp/ParityFunction.java b/src/java/org/apache/poi/ss/formula/atp/ParityFunction.java
index 04b5e9223..29012fe18 100644
--- a/src/java/org/apache/poi/ss/formula/atp/ParityFunction.java
+++ b/src/java/org/apache/poi/ss/formula/atp/ParityFunction.java
@@ -25,7 +25,7 @@ import org.apache.poi.ss.formula.eval.ValueEval;
import org.apache.poi.ss.formula.functions.FreeRefFunction;
import org.apache.poi.ss.formula.OperationEvaluationContext;
/**
- * Implementation of Excel 'Analysis ToolPak' function ISEVEN() ISODD()
*
- * Syntax
*
- * bottom is the smallest integer RANDBETWEEN will return.
+ * Syntax
*
* @author jfaenomoto@gmail.com
*/
diff --git a/src/java/org/apache/poi/ss/formula/atp/YearFrac.java b/src/java/org/apache/poi/ss/formula/atp/YearFrac.java
index a44645f61..bb2134a95 100644
--- a/src/java/org/apache/poi/ss/formula/atp/YearFrac.java
+++ b/src/java/org/apache/poi/ss/formula/atp/YearFrac.java
@@ -29,12 +29,12 @@ import org.apache.poi.ss.formula.functions.FreeRefFunction;
import org.apache.poi.ss.formula.OperationEvaluationContext;
import org.apache.poi.ss.usermodel.DateUtil;
/**
- * Implementation of Excel 'Analysis ToolPak' function YEARFRAC()
*
- * Syntax
*
* The basis optionally specifies the behaviour of YEARFRAC as follows:
*
diff --git a/src/java/org/apache/poi/ss/formula/atp/YearFracCalculator.java b/src/java/org/apache/poi/ss/formula/atp/YearFracCalculator.java
index 473c22536..52cdbd7e0 100644
--- a/src/java/org/apache/poi/ss/formula/atp/YearFracCalculator.java
+++ b/src/java/org/apache/poi/ss/formula/atp/YearFracCalculator.java
@@ -26,7 +26,7 @@ import org.apache.poi.util.LocaleUtil;
/**
- * Internal calculation methods for Excel 'Analysis ToolPak' function YEARFRAC()
*
* @author Josh Micich
*/
diff --git a/src/java/org/apache/poi/ss/formula/constant/ErrorConstant.java b/src/java/org/apache/poi/ss/formula/constant/ErrorConstant.java
index 9d3c898b3..79dd23b92 100644
--- a/src/java/org/apache/poi/ss/formula/constant/ErrorConstant.java
+++ b/src/java/org/apache/poi/ss/formula/constant/ErrorConstant.java
@@ -21,7 +21,7 @@ import org.apache.poi.ss.usermodel.FormulaError;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
/**
- * Represents a constant error code value as encoded in a constant values array.
*
* This class is a type-safe wrapper for a 16-bit int value performing a similar job to
* ErrorEval.
diff --git a/src/java/org/apache/poi/ss/formula/eval/BoolEval.java b/src/java/org/apache/poi/ss/formula/eval/BoolEval.java
index 77a25a361..49fe3cf2a 100644
--- a/src/java/org/apache/poi/ss/formula/eval/BoolEval.java
+++ b/src/java/org/apache/poi/ss/formula/eval/BoolEval.java
@@ -29,7 +29,7 @@ public final class BoolEval implements NumericValueEval, StringValueEval {
public static final BoolEval TRUE = new BoolEval(true);
/**
- * Convenience method for the following:
*
* Here is an example coded without EvaluationException, to show how it can help:
*
*
*
* Note - Only standard evaluation errors are represented by EvaluationException (
* i.e. conditions expected to be encountered when evaluating arbitrary Excel formulas). Conditions
diff --git a/src/java/org/apache/poi/ss/formula/eval/OperandResolver.java b/src/java/org/apache/poi/ss/formula/eval/OperandResolver.java
index d2b899da5..47fd6de0d 100644
--- a/src/java/org/apache/poi/ss/formula/eval/OperandResolver.java
+++ b/src/java/org/apache/poi/ss/formula/eval/OperandResolver.java
@@ -97,10 +97,10 @@ public final class OperandResolver {
*
* Note that the row area (A1:B1) does not include column C and the column area (D2:D3) does
* not include row 4, so the values in C1(=25) and D4(=400) are not accessible to the formula
- * as written, but in the 4 cells A2:B3, the row and column selection works ok.
*
* The same concept is extended to references across sheets, such that even multi-row,
- * multi-column areas can be useful.
*
* Of course with carefully (or carelessly) chosen parameters, cyclic references can occur and
* hence this method can throw a 'circular reference' EvaluationException. Note that
@@ -180,14 +180,14 @@ public final class OperandResolver {
}
/**
- * Applies some conversion rules if the supplied value is not already an integer.
*
- * Excel typically converts doubles to integers by truncating toward negative infinity.
*
* Doesn't support currency prefixes, commas, percentage signs or arithmetic operations strings.
*
- * Some examples:
* @author Josh Micich
*/
public final class PercentEval extends Fixed1ArgFunction {
diff --git a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java
index abd3b9925..8d271e3da 100644
--- a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java
+++ b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java
@@ -34,7 +34,7 @@ import org.apache.poi.util.Internal;
* Represents a sheet being used for forked evaluation. Initially, objects of this class contain
* only the cells from the master workbook. By calling {@link #getOrCreateUpdatableCell(int, int)},
* the master cell object is logically replaced with a {@link ForkedEvaluationCell} instance, which
- * will be used in all subsequent evaluations. Some utils for converting from and to any base Some utils for converting from and to any base
*
* @author cedric dot walter @ gmail dot com
*/
diff --git a/src/java/org/apache/poi/ss/formula/functions/Bin2Dec.java b/src/java/org/apache/poi/ss/formula/functions/Bin2Dec.java
index 92cc2d2c4..69a01fe69 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Bin2Dec.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Bin2Dec.java
@@ -24,16 +24,16 @@ import org.apache.poi.ss.formula.eval.RefEval;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Implementation for Excel Bin2Dec() function.
+ *
+ * Syntax:
* Converts a binary number to decimal.
- *
* Number is the binary number you want to convert. Number cannot contain more than 10 characters (10 bits).
* The most significant bit of number is the sign bit. The remaining 9 bits are magnitude bits.
* Negative numbers are represented using two's-complement notation.
- *
* Remark
* If number is not a valid binary number, or if number contains more than 10 characters (10 bits),
* BIN2DEC returns the #NUM! error value.
diff --git a/src/java/org/apache/poi/ss/formula/functions/Code.java b/src/java/org/apache/poi/ss/formula/functions/Code.java
index 881bcac4a..f285d5858 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Code.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Code.java
@@ -20,12 +20,12 @@ package org.apache.poi.ss.formula.functions;
import org.apache.poi.ss.formula.eval.*;
/**
- * Implementation for Excel CODE () function.
+ *
+ * Syntax:
* Returns a numeric code for the first character in a text string. The returned code corresponds to the character set used by your computer.
- *
* text The text for which you want the code of the first character.
*
* @author cedric dot walter @ gmail dot com
diff --git a/src/java/org/apache/poi/ss/formula/functions/Complex.java b/src/java/org/apache/poi/ss/formula/functions/Complex.java
index 8273f6a05..2282247a5 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Complex.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Complex.java
@@ -27,25 +27,25 @@ import org.apache.poi.ss.formula.eval.StringEval;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Implementation for Excel COMPLEX () function.
+ *
+ * Syntax:
* Converts real and imaginary coefficients into a complex number of the form x + yi or x + yj.
- *
+ *
* All complex number functions accept "i" and "j" for suffix, but neither "I" nor "J".
* Using uppercase results in the #VALUE! error value. All functions that accept two
* or more complex numbers require that all suffixes match.
- *
* real_num The real coefficient of the complex number.
* If this argument is nonnumeric, this function returns the #VALUE! error value.
- *
+ *
* i_num The imaginary coefficient of the complex number.
* If this argument is nonnumeric, this function returns the #VALUE! error value.
- *
+ *
* suffix The suffix for the imaginary component of the complex number.
*
+ *
+ * Syntax:
* Converts a decimal number to binary.
- *
* The DEC2BIN function syntax has the following arguments:
*
* Remarks
*
+ *
+ * Syntax:
* Converts a decimal number to hexadecimal.
*
* The decimal integer you want to convert. If number is negative, places is ignored
diff --git a/src/java/org/apache/poi/ss/formula/functions/Delta.java b/src/java/org/apache/poi/ss/formula/functions/Delta.java
index 0d70e6769..0ad65c375 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Delta.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Delta.java
@@ -23,10 +23,10 @@ import org.apache.poi.ss.formula.eval.*;
import java.math.BigDecimal;
/**
- * Implementation for Excel DELTA() function.
+ *
+ * Syntax:
* Tests whether two values are equal. Returns 1 if number1 = number2; returns 0 otherwise.
* Use this function to filter a set of values. For example, by summing several DELTA functions
* you calculate the count of equal pairs. This function is also known as the Kronecker Delta function.
diff --git a/src/java/org/apache/poi/ss/formula/functions/EOMonth.java b/src/java/org/apache/poi/ss/formula/functions/EOMonth.java
index 6809db15d..f0c5c4bb5 100644
--- a/src/java/org/apache/poi/ss/formula/functions/EOMonth.java
+++ b/src/java/org/apache/poi/ss/formula/functions/EOMonth.java
@@ -29,13 +29,13 @@ import org.apache.poi.ss.usermodel.DateUtil;
import org.apache.poi.util.LocaleUtil;
/**
- * Implementation for the Excel EOMONTH() function.
+ *
+ * EOMONTH() returns the date of the last day of a month..
+ *
+ * Syntax:
+ *
* start_date is the starting date of the calculation
* months is the number of months to be added to start_date,
* to give a new date. For this new date, EOMONTH returns the date of
diff --git a/src/java/org/apache/poi/ss/formula/functions/Errortype.java b/src/java/org/apache/poi/ss/formula/functions/Errortype.java
index 5dea7a3a0..71565fdef 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Errortype.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Errortype.java
@@ -27,10 +27,10 @@ import org.apache.poi.ss.usermodel.FormulaError;
/**
* Implementation for the ERROR.TYPE() Excel function.
*
- * Syntax:
- * Returns a number corresponding to the error type of the supplied argument.
*
*
+ *
+ * Syntax:
* Returns the double factorial of a number.
- *
* Number is the value for which to return the double factorial. If number is not an integer, it is truncated.
- *
* Remarks
*
*
* When POI evaluates formulas, each reference argument is capable of evaluating any cell inside
* its range. Actually, even cells outside the reference range but on the same sheet can be
diff --git a/src/java/org/apache/poi/ss/formula/functions/Hex2Dec.java b/src/java/org/apache/poi/ss/formula/functions/Hex2Dec.java
index 46b92f2e2..c3b1341d9 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Hex2Dec.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Hex2Dec.java
@@ -21,12 +21,12 @@ import org.apache.poi.ss.formula.OperationEvaluationContext;
import org.apache.poi.ss.formula.eval.*;
/**
- * Implementation for Excel HEX2DEC() function.
+ *
+ * Syntax:
* Converts a hexadecimal number to decimal.
- *
* Number is the hexadecimal number you want to convert. Number cannot contain more than 10 characters (40 bits).
* The most significant bit of number is the sign bit.
* The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.
diff --git a/src/java/org/apache/poi/ss/formula/functions/Hlookup.java b/src/java/org/apache/poi/ss/formula/functions/Hlookup.java
index c6190dcba..5658ec49e 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Hlookup.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Hlookup.java
@@ -24,18 +24,18 @@ import org.apache.poi.ss.formula.eval.ValueEval;
import org.apache.poi.ss.formula.functions.LookupUtils.ValueVector;
import org.apache.poi.ss.formula.TwoDEval;
/**
- * Implementation of the HLOOKUP() function.
*
- * HLOOKUP finds a column in a lookup table by the first row value and returns the value from another row.
*
- * lookup_value The value to be found in the first column of the table array.
*
* In Excel this function has special behaviour - it causes the displayed cell value to behave like
- * a hyperlink in the GUI. From an evaluation perspective however, it is very simple.
*
- * Syntax:
*
- * link_location The URL of the hyperlink
*
* Returns last argument. Leaves type unchanged (does not convert to {@link org.apache.poi.ss.formula.eval.StringEval}).
*
diff --git a/src/java/org/apache/poi/ss/formula/functions/ImReal.java b/src/java/org/apache/poi/ss/formula/functions/ImReal.java
index 4687ccc9d..0c7b81ada 100644
--- a/src/java/org/apache/poi/ss/formula/functions/ImReal.java
+++ b/src/java/org/apache/poi/ss/formula/functions/ImReal.java
@@ -27,14 +27,14 @@ import org.apache.poi.ss.formula.eval.StringEval;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Implementation for Excel ImReal() function.
+ *
+ * Syntax:
* Returns the real coefficient of a complex number in x + yi or x + yj text format.
- *
* Inumber A complex number for which you want the real coefficient.
- *
* Remarks
*
+ *
+ * Syntax:
* Returns the imaginary coefficient of a complex number in x + yi or x + yj text format.
- *
* Inumber is a complex number for which you want the imaginary coefficient.
- *
* Remarks
*
*
- * Syntax :
*
- * INDIRECT() returns the cell or area reference denoted by the text argument.
*
* Syntax:
- * INDIRECT(ref_text,isA1Style)
*
* ref_text a string representation of the desired reference as it would
- * normally be written in a cell formula.
*
- * Calculates the INTERCEPT of the linear regression line that is used to predict y values from x values
*
*
* @author Johan Karlsteen
diff --git a/src/java/org/apache/poi/ss/formula/functions/LinearRegressionFunction.java b/src/java/org/apache/poi/ss/formula/functions/LinearRegressionFunction.java
index 73a0204be..e36094c26 100644
--- a/src/java/org/apache/poi/ss/formula/functions/LinearRegressionFunction.java
+++ b/src/java/org/apache/poi/ss/formula/functions/LinearRegressionFunction.java
@@ -30,12 +30,12 @@ import org.apache.poi.ss.formula.functions.LookupUtils.ValueVector;
/**
* Base class for linear regression functions.
*
- * Calculates the linear regression line that is used to predict y values from x values
* or
- * SLOPE(arrayX, arrayY)
*
*
* @author Johan Karlsteen
diff --git a/src/java/org/apache/poi/ss/formula/functions/LogicalFunction.java b/src/java/org/apache/poi/ss/formula/functions/LogicalFunction.java
index 1bf9cf5ca..a3fe30474 100644
--- a/src/java/org/apache/poi/ss/formula/functions/LogicalFunction.java
+++ b/src/java/org/apache/poi/ss/formula/functions/LogicalFunction.java
@@ -82,12 +82,12 @@ public abstract class LogicalFunction extends Fixed1ArgFunction {
};
/**
- * Implementation of Excel ISERR() function.
*
- * Syntax:
*
- * value The value to be tested
*
* Returns the logical value TRUE if value refers to any error value except
* '#N/A'; otherwise, it returns FALSE.
@@ -103,13 +103,13 @@ public abstract class LogicalFunction extends Fixed1ArgFunction {
};
/**
- * Implementation for Excel ISNA() function.
*
- * Syntax:
*
- * value The value to be tested
*
* LOOKUP finds an index row in a lookup table by the first column value and returns the value from another column.
*
- * Syntax:
*
- * lookup_value The value to be found in the lookup vector.
* Excel lookup functions have complex behaviour in the case where the lookup array has mixed
* types, and/or is unordered. Contrary to suggestions in some Excel documentation, there
* does not appear to be a universal ordering across types. The binary search algorithm used
- * changes behaviour when the evaluated 'mid' value has a different type to the lookup value.
*
* A simple int might have done the same job, but there is risk in confusion with the well
* known Comparable.compareTo() and Comparator.compare() which both use
@@ -366,7 +366,7 @@ final class LookupUtils {
*
*
- * Syntax:
*
* Returns a 1-based index specifying at what position in the lookup_array the specified
- * lookup_value is found.
*
* Specific matching behaviour can be modified with the optional match_type parameter.
*
@@ -55,8 +55,8 @@ import org.apache.poi.ss.formula.functions.LookupUtils.ValueVector;
* be ordered, MATCH() can produce incorrect results if this requirement is not met. Observed
* behaviour in Excel is to return the lowest index value for which every item after that index
* breaks the match rule. If d is NaN, then 1 will be returned. It is the responsibility
* of caller to check for d isNaN if some other value is desired.
@@ -203,7 +203,7 @@ final class MathX {
* Note: this function is different from java.lang.Math.floor(..).
*
* When n and s are "valid" arguments, the returned value is: Math.floor(n/s) * s;
- *
* When n and s are "valid" arguments, the returned value is: Math.ceiling(n/s) * s;
- * Implementation for Excel Oct2Dec() function. Implementation for Excel Oct2Dec() function.
*
* Converts an octal number to decimal.
*
- * Syntax:
* Number is the octal number you want to convert. Number may not contain more than 10 octal characters (30 bits).
* The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits.
* Negative numbers are represented using two's-complement notation..
- *
* If number is not a valid octal number, OCT2DEC returns the #NUM! error value.
*
* @author cedric dot walter @ gmail dot com
diff --git a/src/java/org/apache/poi/ss/formula/functions/Offset.java b/src/java/org/apache/poi/ss/formula/functions/Offset.java
index 37ae8e682..b69b0990c 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Offset.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Offset.java
@@ -25,18 +25,18 @@ import org.apache.poi.ss.formula.eval.OperandResolver;
import org.apache.poi.ss.formula.eval.RefEval;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Implementation for Excel function OFFSET()
*
* OFFSET returns an area reference that is a specified number of rows and columns from a
- * reference cell or area.
*
- * Syntax:
+ * reference is the base reference.
*
* This method also 'normalises' the range: Excel specifies that the width and height
* parameters (length field here) cannot be negative. However, OFFSET() does produce
- * sensible results in these cases. That behavior is replicated here.
*
* @param translationAmount may be zero negative or positive
*
diff --git a/src/java/org/apache/poi/ss/formula/functions/Quotient.java b/src/java/org/apache/poi/ss/formula/functions/Quotient.java
index 4adac7980..9bac12fc3 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Quotient.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Quotient.java
@@ -23,16 +23,16 @@ import org.apache.poi.ss.formula.eval.ValueEval;
import org.apache.poi.ss.formula.eval.*;
/**
- * Implementation for Excel QUOTIENT () function. Implementation for Excel QUOTIENT () function.
+ *
+ * Syntax:
- * Syntax:
* Numerator is the dividend.
* Denominator is the divisor.
*
* Returns the integer portion of a division. Use this function when you want to discard the remainder of a division.
- *
*
* If either enumerator/denominator is non numeric, QUOTIENT returns the #VALUE! error value.
* If denominator is equals to zero, QUOTIENT returns the #DIV/0! error value.
diff --git a/src/java/org/apache/poi/ss/formula/functions/Replace.java b/src/java/org/apache/poi/ss/formula/functions/Replace.java
index dd366dbd2..4045d9260 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Replace.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Replace.java
@@ -23,17 +23,17 @@ import org.apache.poi.ss.formula.eval.StringEval;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * An implementation of the Excel REPLACE() function:
* Replaces part of a text string based on the number of characters
- * you specify, with another text string.
*
- * oldText The text string containing characters to replace
+ *
+ * Syntax:
* Repeats text a given number of times. Use REPT to fill a cell with a number of instances of a text string.
*
* text : text The text that you want to repeat.
diff --git a/src/java/org/apache/poi/ss/formula/functions/Roman.java b/src/java/org/apache/poi/ss/formula/functions/Roman.java
index ff06443f9..d73e32257 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Roman.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Roman.java
@@ -24,13 +24,13 @@ import org.apache.poi.ss.formula.eval.StringEval;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Implementation for Excel WeekNum() function.
+ *
+ * Syntax:
* Returns a number that indicates where the week falls numerically within a year.
- *
+ *
* Serial_num is a date within the week. Dates should be entered by using the DATE function,
* or as results of other formulas or functions. For example, use DATE(2008,5,23)
* for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
diff --git a/src/java/org/apache/poi/ss/formula/functions/Slope.java b/src/java/org/apache/poi/ss/formula/functions/Slope.java
index 63449d568..cb8b07aee 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Slope.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Slope.java
@@ -23,12 +23,12 @@ import org.apache.poi.ss.formula.eval.ValueEval;
import org.apache.poi.ss.formula.functions.LinearRegressionFunction.FUNCTION;
/**
- * Implementation of Excel function SLOPE()
*
- * Calculates the SLOPE of the linear regression line that is used to predict y values from x values
*
*
* @author Johan Karlsteen
diff --git a/src/java/org/apache/poi/ss/formula/functions/StatsLib.java b/src/java/org/apache/poi/ss/formula/functions/StatsLib.java
index ebef9d4b2..528a14c51 100644
--- a/src/java/org/apache/poi/ss/formula/functions/StatsLib.java
+++ b/src/java/org/apache/poi/ss/formula/functions/StatsLib.java
@@ -116,7 +116,7 @@ final class StatsLib {
* returns the kth largest element in the array. Duplicates
* are considered as distinct values. Hence, eg.
* for array {1,2,4,3,3} & k=2, returned value is 3.
- *
* Substitutes text in a text string with new text, some number of times.
* @author Manda Wilson < wilson at c bio dot msk cc dot org >
*/
diff --git a/src/java/org/apache/poi/ss/formula/functions/Subtotal.java b/src/java/org/apache/poi/ss/formula/functions/Subtotal.java
index f3b24cd1c..c2c582935 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Subtotal.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Subtotal.java
@@ -35,12 +35,12 @@ import java.util.List;
/**
* Implementation for the Excel function SUBTOTAL
*
- * Syntax :
*
* @author Paul Tomlin < pault at bulk sms dot com >
*/
diff --git a/src/java/org/apache/poi/ss/formula/functions/Sumif.java b/src/java/org/apache/poi/ss/formula/functions/Sumif.java
index 977647fd2..ceeff9b1d 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Sumif.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Sumif.java
@@ -28,13 +28,13 @@ import org.apache.poi.ss.formula.functions.CountUtils.I_MatchPredicate;
/**
* Implementation for the Excel function SUMIF
*
- * Syntax :
*
- * Syntax :
*
- * Syntax :
* Note - string values and empty cells are interpreted differently depending on
*
*
- * Calculates the sum of differences of squares in two arrays of the same size.
*
* result = Σi: 0..n(xi2-yi2)
*
diff --git a/src/java/org/apache/poi/ss/formula/functions/Sumx2py2.java b/src/java/org/apache/poi/ss/formula/functions/Sumx2py2.java
index 6e40445a4..cae17d7e3 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Sumx2py2.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Sumx2py2.java
@@ -19,11 +19,11 @@ package org.apache.poi.ss.formula.functions;
/**
- * Implementation of Excel function SUMX2PY2()
*
- * Calculates the sum of squares in two arrays of the same size.
*
* result = Σi: 0..n(xi2+yi2)
*
diff --git a/src/java/org/apache/poi/ss/formula/functions/Sumxmy2.java b/src/java/org/apache/poi/ss/formula/functions/Sumxmy2.java
index 3955d06da..1d5effa0c 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Sumxmy2.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Sumxmy2.java
@@ -18,11 +18,11 @@
package org.apache.poi.ss.formula.functions;
/**
- * Implementation of Excel function SUMXMY2()
*
- * Calculates the sum of squares of differences between two arrays of the same size.
*
* result = Σi: 0..n(xi-yi)2
*
diff --git a/src/java/org/apache/poi/ss/formula/functions/T.java b/src/java/org/apache/poi/ss/formula/functions/T.java
index 1e74c5b10..28895d0ad 100644
--- a/src/java/org/apache/poi/ss/formula/functions/T.java
+++ b/src/java/org/apache/poi/ss/formula/functions/T.java
@@ -25,7 +25,7 @@ import org.apache.poi.ss.formula.eval.ValueEval;
/**
* Implementation of Excel T() function
- *
* If the argument is a text or error value it is returned unmodified. All other argument types
* cause an empty string result. If the argument is an area, the first (top-left) cell is used
* (regardless of the coordinates of the evaluating formula cell).
diff --git a/src/java/org/apache/poi/ss/formula/functions/TextFunction.java b/src/java/org/apache/poi/ss/formula/functions/TextFunction.java
index c8b4b3ca0..cc9c2c797 100644
--- a/src/java/org/apache/poi/ss/formula/functions/TextFunction.java
+++ b/src/java/org/apache/poi/ss/formula/functions/TextFunction.java
@@ -182,12 +182,12 @@ public abstract class TextFunction implements Function {
};
/**
- * An implementation of the MID function
*
- * Syntax:
*
- * Syntax:
*
* FIND returns the character position of the first (case sensitive) occurrence of
* find_text inside within_text. The third parameter,
* start_num, is optional (default=1) and specifies where to start searching
- * from. Character positions are 1-based.
*
* Author: Torstein Tauno Svendsen (torstei@officenet.no)
*/
public static final Function FIND = new SearchFind(true);
/**
- * Implementation of the FIND() function.
*
- * Syntax:
*
* SEARCH is a case-insensitive version of FIND()
*/
diff --git a/src/java/org/apache/poi/ss/formula/functions/Today.java b/src/java/org/apache/poi/ss/formula/functions/Today.java
index d86844aa2..677d1f0e4 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Today.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Today.java
@@ -25,7 +25,7 @@ import org.apache.poi.ss.usermodel.DateUtil;
import org.apache.poi.util.LocaleUtil;
/**
- * Implementation of Excel TODAY() Function
*
- * Syntax:
*
- * VLOOKUP finds a row in a lookup table by the first column value and returns the value from another column.
*
- * lookup_value The value to be found in the first column of the table array.
+ *
+ * Syntax:
* Returns a number that indicates where the week falls numerically within a year.
- *
+ *
* Serial_num is a date within the week. Dates should be entered by using the DATE function,
* or as results of other formulas or functions. For example, use DATE(2008,5,23)
* for the 23rd day of May, 2008. Problems can occur if dates are entered as text.
diff --git a/src/java/org/apache/poi/ss/formula/ptg/Ptg.java b/src/java/org/apache/poi/ss/formula/ptg/Ptg.java
index 73885703b..fc5e6e899 100644
--- a/src/java/org/apache/poi/ss/formula/ptg/Ptg.java
+++ b/src/java/org/apache/poi/ss/formula/ptg/Ptg.java
@@ -29,7 +29,7 @@ import org.apache.poi.util.LittleEndianOutput;
* 'parse thing'. Originally, the name referred to the single
* byte identifier at the start of the token, but in POI, Ptg encapsulates
* the whole formula token (initial byte + value data).
- *
*
* Ptgs are logically arranged in a tree representing the structure of the
* parsed formula. However, in BIFF files Ptgs are written/read in
@@ -192,7 +192,7 @@ public abstract class Ptg {
/**
* Writes the ptgs to the data buffer, starting at the specified offset.
*
- *
+ *
+ * 0, "General"
* // 0x17 - 0x24 reserved for international and undocumented
- * 0x25, "#,##0_);(#,##0)"
*/
public final class BuiltinFormats {
/**
@@ -145,7 +145,7 @@ public final class BuiltinFormats {
}
/**
- * Get the format index that matches the given format string.
* Instance names match the constants from
*
* This is always {@link ConditionFilterType#FILTER} for HSSF rules of type {@link ConditionType#FILTER}.
- *
* For XSSF filter rules, this will indicate the specific type of filter.
*
* @return filter type for filter rules, or null if not a filter rule.
@@ -105,11 +105,11 @@ public interface ConditionalFormattingRule extends DifferentialStyleProvider {
/**
* This is null if
- *
*
* This means it is always null for HSSF, which does not define the extended condition types.
- *
* This object contains the additional configuration information for XSSF filter conditions.
*
* @return the Filter Configuration Data, or null if there isn't any
@@ -154,13 +154,13 @@ public interface ConditionalFormattingRule extends DifferentialStyleProvider {
/**
* The priority of the rule, if defined, otherwise 0.
- *
* If priority is 0, just use definition order, as that's how older HSSF rules
* are evaluated.
- *
* For XSSF, this should always be set. For HSSF, only newer style rules
* have this set, older ones will return 0.
- *
* If a rule is created but not yet added to a sheet, this value may not be valid.
* @return rule priority
*/
diff --git a/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java.svntmp b/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java.svntmp
index aa16c7761..5e534442e 100644
--- a/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java.svntmp
+++ b/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java.svntmp
@@ -86,11 +86,11 @@ public interface ConditionalFormattingRule {
/**
* This is null if
- *
*
* This is always {@link ConditionFilterType#FILTER} for HSSF rules of type {@link ConditionType#FILTER}.
- *
* For XSSF filter rules, this will indicate the specific type of filter.
*
* @return filter type for filter rules, or null if not a filter rule.
@@ -99,11 +99,11 @@ public interface ConditionalFormattingRule {
/**
* This is null if
- *
*
* This means it is always null for HSSF, which does not define the extended condition types.
- *
* This object contains the additional configuration information for XSSF filter conditions.
*
* @return
@@ -149,9 +149,9 @@ public interface ConditionalFormattingRule {
/**
* HSSF just returns 0, XSSF uses the value stored in the model if present,
* otherwise uses 0.
- *
* If priority is 0, just use definition order, as that's how HSSF rules are evaluated.
- *
* If a rule is created but not yet added to a sheet, this value may not be valid.
* @return rule priority
diff --git a/src/java/org/apache/poi/ss/usermodel/DataFormatter.java b/src/java/org/apache/poi/ss/usermodel/DataFormatter.java
index f8dd2aefd..9cacd0d6f 100644
--- a/src/java/org/apache/poi/ss/usermodel/DataFormatter.java
+++ b/src/java/org/apache/poi/ss/usermodel/DataFormatter.java
@@ -802,7 +802,7 @@ public class DataFormatter implements Observer {
* Returns the formatted value of an Excel date as a String based
* on the cell's
* If any conditional format rules apply, the highest priority with a number format is used.
* If no rules contain a number format, or no rules apply, the cell's style format is used.
* If the style does not have a format, the default date format is applied.
@@ -828,7 +828,7 @@ public class DataFormatter implements Observer {
* based on the cell's
* Format comes from either the highest priority conditional format rule with a
* specified format, or from the cell style.
*
diff --git a/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java b/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java
index 4346babb6..81e72c91d 100644
--- a/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java
+++ b/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java
@@ -20,7 +20,7 @@ package org.apache.poi.ss.usermodel;
import java.util.Map;
/**
- * Evaluates formula cells.
*
* For performance reasons, this class keeps a cache of all previously calculated intermediate
* cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between
diff --git a/src/java/org/apache/poi/ss/usermodel/Picture.java b/src/java/org/apache/poi/ss/usermodel/Picture.java
index 8cc17a03b..ac7d33dd2 100644
--- a/src/java/org/apache/poi/ss/usermodel/Picture.java
+++ b/src/java/org/apache/poi/ss/usermodel/Picture.java
@@ -46,9 +46,9 @@ public interface Picture extends Shape {
* If the default font is changed the resized image can be streched vertically or horizontally.
*
- *
* The order is the specification order of application, with later elements overriding previous
* ones, if style properties conflict.
- *
* Processing could iterate bottom-up if looking for specific properties, and stop when the
* first style is found defining a value for that property.
- *
* Enum names match the OOXML spec values exactly, so {@link #valueOf(String)} will work.
*
* @since 3.17 beta 1
diff --git a/src/java/org/apache/poi/ss/usermodel/Workbook.java b/src/java/org/apache/poi/ss/usermodel/Workbook.java
index 4e3d001f5..036cf6c4f 100644
--- a/src/java/org/apache/poi/ss/usermodel/Workbook.java
+++ b/src/java/org/apache/poi/ss/usermodel/Workbook.java
@@ -395,7 +395,7 @@ public interface Workbook extends Closeable, Iterable
* Example return values:
*
*
* In the Microsoft documentation, this is also known as a
* Ref8U - see page 831 of version 1.0 of the documentation.
diff --git a/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java b/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java
index cd1052ef2..bd9500073 100644
--- a/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java
+++ b/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java
@@ -25,7 +25,7 @@ import org.apache.poi.ss.usermodel.Cell;
/**
- * See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'
*
* Common superclass of 8-bit and 16-bit versions
*/
@@ -149,7 +149,7 @@ public abstract class CellRangeAddressBase {
/**
* Determines if the given {@link CellReference} lies within the bounds
* of this range.
- * NOTE: It is up to the caller to ensure the reference is
* for the correct sheet, since this instance doesn't have a sheet reference.
*
* @param ref the CellReference to check
@@ -163,7 +163,7 @@ public abstract class CellRangeAddressBase {
/**
* Determines if the given {@link Cell} lies within the bounds
* of this range.
- * NOTE: It is up to the caller to ensure the reference is
* for the correct sheet, since this instance doesn't have a sheet reference.
*
* @param cell the Cell to check
diff --git a/src/java/org/apache/poi/ss/util/CellRangeUtil.java b/src/java/org/apache/poi/ss/util/CellRangeUtil.java
index 3fd013577..e60230ed8 100644
--- a/src/java/org/apache/poi/ss/util/CellRangeUtil.java
+++ b/src/java/org/apache/poi/ss/util/CellRangeUtil.java
@@ -41,7 +41,7 @@ public final class CellRangeUtil {
* Get the type of intersection between two cell ranges
*
* @param crB - the specified range
- * @return code which reflects how the specified range is related to this range.
* Note - that the maximum sheet size varies across Excel versions:
- *
*
* Example return values:
*
+ * The value of a {@link ExpandedDouble} is given by
* This class does not handle negative numbers or zero.
- *
+ * The value of a {@link NormalisedDecimal} is given by
* In Excel formula evaluation, expressions like "(0.06-0.01)=0.05" evaluate to "TRUE" even
* though the equivalent java expression is
+ *
* Note - Excel also gives special treatment to expressions like "0.06-0.01-0.05" which
* evaluates to "0" (in java, rounding anomalies give a result of 6.9E-18). The special
* behaviour here is for different reasons to the example above: If the last operator in a
* cell formula is '+' or '-' and the result is less than 250 times smaller than
* first operand, the result is rounded to zero.
* Needless to say, the two rules are not consistent and it is relatively easy to find
- * examples that satisfy
*
* Use {@link #getCellWithMerges(Sheet, int, int)} if you want the top left
* cell from merged regions instead when the reference is a merged cell.
- *
* Use this where you want to know if the given cell is explicitly defined
* or not.
*
diff --git a/src/java/org/apache/poi/util/DelayableLittleEndianOutput.java b/src/java/org/apache/poi/util/DelayableLittleEndianOutput.java
index 13282ac37..6dd4930b9 100644
--- a/src/java/org/apache/poi/util/DelayableLittleEndianOutput.java
+++ b/src/java/org/apache/poi/util/DelayableLittleEndianOutput.java
@@ -18,7 +18,7 @@
package org.apache.poi.util;
/**
* Implementors of this interface allow client code to 'delay' writing to a certain section of a
- * data output stream.
*
*
* This class does not buffer any input, so the stream read position maintained
* by this class is consistent with that of the inner stream.
diff --git a/src/java/org/apache/poi/util/ReplacingInputStream.java b/src/java/org/apache/poi/util/ReplacingInputStream.java
index 1b5430e99..47c153432 100644
--- a/src/java/org/apache/poi/util/ReplacingInputStream.java
+++ b/src/java/org/apache/poi/util/ReplacingInputStream.java
@@ -66,7 +66,7 @@ public class ReplacingInputStream extends FilterInputStream {
/**
* Replace occurrences of pattern in the input.
*
- * If you want to normalize line endings DOS/MAC (\n\r | \r) to UNIX (\n), you can call the following:
* Note this is only valid for workbooks using the default Excel font.
- *
* Would be nice to eventually support arbitrary document default fonts.
*/
public static final float DEFAULT_CHARACTER_WIDTH = 7.0017f;
diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java
index 78c6e9c9b..0d651ad9c 100644
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java
@@ -229,7 +229,7 @@ public class SXSSFCell implements Cell {
/**
* Converts the supplied date to its equivalent Excel numeric value and sets
* that into the cell.
- *
* Note - There is actually no 'DATE' cell type in Excel. In many
* cases (when entering date values), Excel automatically adjusts the
* cell style to some date format, creating the illusion that the cell
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/CustomIndexedColorMap.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/CustomIndexedColorMap.java
index 3cfed531b..05d442db7 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/CustomIndexedColorMap.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/CustomIndexedColorMap.java
@@ -42,9 +42,9 @@ public class CustomIndexedColorMap implements IndexedColorMap {
/**
* OOXML spec says if this exists it must have all indexes.
- *
* From the OOXML Spec, Part 1, section 18.8.27:
- *
* This element contains a sequence of RGB color values that correspond to color indexes (zero-based). When
* using the default indexed color palette, the values are not written out, but instead are implied. When the color
* palette has been modified from default, then the entire color palette is written out.
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFBuiltinTableStyle.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFBuiltinTableStyle.java
index 828ceeeec..67555566f 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFBuiltinTableStyle.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFBuiltinTableStyle.java
@@ -365,7 +365,7 @@ public enum XSSFBuiltinTableStyle {
* Only init once - thus the synchronized. Lazy, after creating instances,
* and only when a style is actually needed, to avoid overhead for uses
* that don't need the actual style definitions.
- *
* Public so clients can initialize the map on startup rather than lazily
* during evaluation if desired.
*/
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
index 7afb3896f..1b6886467 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
@@ -692,7 +692,7 @@ public final class XSSFCell implements Cell {
* Return the cell type. Tables in an array formula return
* {@link CellType#FORMULA} for all cells, even though the formula is only defined
* in the OOXML file for the top left cell of the array.
- *
* NOTE: POI does not support data table formulas.
* Cells in a data table appear to POI as plain cells typed from their cached value.
*
@@ -1192,7 +1192,7 @@ public final class XSSFCell implements Cell {
}
/**
- * Chooses a new boolean value for the cell when its type is changing.
*
* Usually the caller is calling setCellType() with the intention of calling
* setCellValue(boolean) straight afterwards. This method only exists to give
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java
index 96527d515..65d23f01c 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java
@@ -364,7 +364,7 @@ public class XSSFCellStyle implements CellStyle {
/**
* Get the color to use for the bottom border
- *
* Expressed in degrees. Values range from 0 to 180. The first letter of
* the text is considered the center-point of the arc.
- *
* Expressed in degrees. Values range from 0 to 180. The first letter of
* the text is considered the center-point of the arc.
- *
*
* For performance reasons, this class keeps a cache of all previously calculated intermediate
* cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFMap.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFMap.java
index d4d148c87..d71d7a68f 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFMap.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFMap.java
@@ -34,7 +34,7 @@ import org.w3c.dom.Node;
/**
* This class implements the Map element (Open Office XML Part 4:
* chapter 3.16.2)
- *
* This element contains all of the properties related to the XML map,
* and the behaviors expected during data refresh operations.
*
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java
index e4055b3e5..2d8bffb15 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java
@@ -163,9 +163,9 @@ public final class XSSFPicture extends XSSFShape implements Picture {
* If the default font is changed the resized image can be streched vertically or horizontally.
*
- *
* Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
* You can grab the picture data directly from the underlying package part as follows:
- *
* TODO - formulas containing cell references are currently not parsed properly
*
* @param comparisonOperation - a constant value from
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFVMLDrawing.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFVMLDrawing.java
index 7a7f02f6c..b6874a481 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFVMLDrawing.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFVMLDrawing.java
@@ -130,7 +130,7 @@ public final class XSSFVMLDrawing extends POIXMLDocumentPart {
* The result is that they contain things like >br<, which breaks the XML parsing.
* This very sick InputStream wrapper attempts to spot these go past, and fix them.
*/
- doc = DocumentHelper.readDocument(new ReplacingInputStream(is, "
*
* Care must be taken if the removed sheet is the currently active or only selected sheet in
* the workbook. There are a few situations when Excel must have a selection and/or active
- * sheet. (For example when printing - see Bug 40414).
* Expressed in degrees. Values range from 0 to 180. The first letter of
* the text is considered the center-point of the arc.
- *
* Expressed in degrees. Values range from 0 to 180. The first letter of
* the text is considered the center-point of the arc.
- *
*
* The idea is to parse every formula and render it back to string
* with the updated sheet name. This is done by parsing into Ptgs,
diff --git a/src/ooxml/java/org/apache/poi/xssf/util/EvilUnclosedBRFixingInputStream.java b/src/ooxml/java/org/apache/poi/xssf/util/EvilUnclosedBRFixingInputStream.java
index 0ef1aeeb5..65401148e 100644
--- a/src/ooxml/java/org/apache/poi/xssf/util/EvilUnclosedBRFixingInputStream.java
+++ b/src/ooxml/java/org/apache/poi/xssf/util/EvilUnclosedBRFixingInputStream.java
@@ -41,6 +41,6 @@ import org.apache.poi.util.ReplacingInputStream;
@Internal
public class EvilUnclosedBRFixingInputStream extends ReplacingInputStream {
public EvilUnclosedBRFixingInputStream(InputStream source) {
- super(source, "
* WARNING - APIs expected to change rapidly.
- *
* These classes have so far been built only for read-only processing.
*/
public abstract class AbstractXWPFSDT implements ISDTContents {
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/BreakClear.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/BreakClear.java
index 0f44f21f7..5e49ee479 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/BreakClear.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/BreakClear.java
@@ -33,7 +33,7 @@ public enum BreakClear {
* line in the WordprocessingML document, regardless of its position left to
* right or the presence of any floating objects which intersect with the
* line,
- *
* This is the setting for a typical line break in a document.
*/
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/ICell.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/ICell.java
index d5a76429d..c89f93960 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/ICell.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/ICell.java
@@ -19,7 +19,7 @@ package org.apache.poi.xwpf.usermodel;
/**
* Interface for anything that can be at a table cell level:
* {@link XWPFTableCell}, {@link XWPFSDTCell}
- *
* Schematically something like this:
* <tr><tc/><tc/><sdt><tc/></sdt></tr>
*/
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/IRunBody.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/IRunBody.java
index fea7856d1..243014799 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/IRunBody.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/IRunBody.java
@@ -22,7 +22,7 @@ import org.apache.poi.wp.usermodel.Paragraph;
/**
* Simple interface describing both {@link XWPFParagraph}
* and {@link XWPFSDT}
- *
* TODO Should this be based on / extend {@link Paragraph}?
*/
public interface IRunBody {
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/IRunElement.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/IRunElement.java
index e8d1b83e7..9c87820fa 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/IRunElement.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/IRunElement.java
@@ -23,7 +23,7 @@ import org.apache.poi.wp.usermodel.CharacterRun;
* where a run (text with common stylings) can,
* eg {@link XWPFRun} or {@link XWPFSDT}.
* TODO More methods to follow shortly!
- *
* TODO Make this based on {@link CharacterRun}
*/
public interface IRunElement {}
\ No newline at end of file
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/ISDTContent.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/ISDTContent.java
index dad119e00..d0c185e88 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/ISDTContent.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/ISDTContent.java
@@ -20,9 +20,9 @@ package org.apache.poi.xwpf.usermodel;
/**
* Experimental interface to offer rudimentary read-only processing of
* of the contentblock of an SDT/ContentControl.
- *
+ *
+ *
* WARNING - APIs expected to change rapidly
*/
public interface ISDTContent {
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
index 9afde2caf..081b751cd 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFDocument.java
@@ -67,7 +67,7 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.*;
/**
* High(ish) level class for working with .docx files.
* This class tries to hide some of the complexity
* of the underlying file format, but as it's not a
* mature and stable API yet, certain parts of the
@@ -969,9 +969,9 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Verifies that the documentProtection tag in settings.xml file
* NOTICES:
* A Paragraph within a Document, Table, Header etc.
* A paragraph has a lot of styling information, but the
* actual text (possibly along with more styling) is held on
* the child {@link XWPFRun}s.
+ *
* If this element is not set on a given paragraph, its value is determined
* by the setting previously set at any level of the style hierarchy (i.e.
* that previous setting remains unchanged). If this setting is never
@@ -448,8 +448,8 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
/**
* Specifies the paragraph alignment which shall be applied to text in this
* paragraph.
- *
+ *
* If this element is not set on a given paragraph, its value is determined
* by the setting previously set at any level of the style hierarchy (i.e.
* that previous setting remains unchanged). If this setting is never
@@ -483,12 +483,12 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
/**
* Returns the text vertical alignment which shall be applied to text in
* this paragraph.
- *
* If the line height (before any added spacing) is larger than one or more
* characters on the line, all characters will be aligned to each other as
* specified by this element.
*
* If this element is omitted on a given paragraph, its value is determined
* by the setting previously set at any level of the style hierarchy (i.e.
* that previous setting remains unchanged). If this setting is never
@@ -508,12 +508,12 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
/**
* Specifies the text vertical alignment which shall be applied to text in
* this paragraph.
- *
* If the line height (before any added spacing) is larger than one or more
* characters on the line, all characters will be aligned to each other as
* specified by this element.
*
* If this element is omitted on a given paragraph, its value is determined
* by the setting previously set at any level of the style hierarchy (i.e.
* that previous setting remains unchanged). If this setting is never
@@ -554,8 +554,8 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
/**
* Specifies the border which shall be displayed above a set of paragraphs
* which have the same set of paragraph border settings.
- *
+ *
* To determine if any two adjoining paragraphs shall have an individual top
* and bottom border or a between border, the set of borders on the two
* adjoining paragraphs are compared. If the border information on those two
@@ -566,7 +566,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* determines the space above the text (ignoring any spacing above) which
* should be left before this border is drawn, specified in points.
*
* If this element is omitted on a given paragraph, its value is determined
* by the setting previously set at any level of the style hierarchy (i.e.
* that previous setting remains unchanged). If this setting is never
@@ -613,7 +613,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
/**
* Specifies the border which shall be displayed below a set of paragraphs
* which have the same set of paragraph border settings.
- *
* To determine if any two adjoining paragraphs shall have an individual top
* and bottom border or a between border, the set of borders on the two
* adjoining paragraphs are compared. If the border information on those two
@@ -625,7 +625,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* below) which should be left before this border is drawn, specified in
* points.
*
* If this element is omitted on a given paragraph, its value is determined
* by the setting previously set at any level of the style hierarchy (i.e.
* that previous setting remains unchanged). If this setting is never
@@ -668,7 +668,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
/**
* Specifies the border which shall be displayed on the left side of the
* page around the specified paragraph.
- *
* To determine if any two adjoining paragraphs should have a left border
* which spans the full line height or not, the left border shall be drawn
* between the top border or between border at the top (whichever would be
@@ -676,7 +676,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* border at the bottom (whichever would be rendered for the current
* paragraph).
*
* If this element is omitted on a given paragraph, its value is determined
* by the setting previously set at any level of the style hierarchy (i.e.
* that previous setting remains unchanged). If this setting is never
@@ -718,7 +718,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
/**
* Specifies the border which shall be displayed on the right side of the
* page around the specified paragraph.
- *
* To determine if any two adjoining paragraphs should have a right border
* which spans the full line height or not, the right border shall be drawn
* between the top border or between border at the top (whichever would be
@@ -726,7 +726,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* border at the bottom (whichever would be rendered for the current
* paragraph).
*
* If this element is omitted on a given paragraph, its value is determined
* by the setting previously set at any level of the style hierarchy (i.e.
* that previous setting remains unchanged). If this setting is never
@@ -768,7 +768,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
/**
* Specifies the border which shall be displayed between each paragraph in a
* set of paragraphs which have the same set of paragraph border settings.
- *
* To determine if any two adjoining paragraphs should have a between border
* or an individual top and bottom border, the set of borders on the two
* adjoining paragraphs are compared. If the border information on those two
@@ -779,7 +779,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* bottom of each paragraph with an identical following paragraph, taking
* into account any space after the line pitch.
*
* If this element is omitted on a given paragraph, its value is determined
* by the setting previously set at any level of the style hierarchy (i.e.
* that previous setting remains unchanged). If this setting is never
@@ -805,7 +805,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* Specifies that when rendering this document in a paginated
* view, the contents of this paragraph are rendered on the start of a new
* page in the document.
- *
* If this element is omitted on a given paragraph,
* its value is determined by the setting previously set at any level of the
* style hierarchy (i.e. that previous setting remains unchanged). If this
@@ -847,7 +847,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* Specifies that when rendering this document in a paginated
* view, the contents of this paragraph are rendered on the start of a new
* page in the document.
- *
* If this element is omitted on a given paragraph,
* its value is determined by the setting previously set at any level of the
* style hierarchy (i.e. that previous setting remains unchanged). If this
@@ -884,7 +884,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
/**
* Specifies the spacing that should be added after the last line in this
* paragraph in the document in absolute units.
- *
* If the afterLines attribute or the afterAutoSpacing attribute is also
* specified, then this attribute value is ignored.
*
* If the afterAutoSpacing attribute
* is also specified, then this attribute value is ignored. If this setting
* is never specified in the style hierarchy, then its value shall be zero
@@ -952,7 +952,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
/**
* Specifies the spacing that should be added above the first line in this
* paragraph in the document in absolute units.
- *
* If the beforeLines attribute or the beforeAutoSpacing attribute is also
* specified, then this attribute value is ignored.
*
* If the beforeAutoSpacing attribute is also specified, then this attribute
* value is ignored. If this setting is never specified in the style
* hierarchy, then its value shall be zero.
@@ -1084,7 +1084,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* margin for this paragraph and the left edge of that paragraph's content
* in a left to right paragraph, and the right text margin and the right
* edge of that paragraph's text in a right to left paragraph
- *
* If this attribute is omitted, its value shall be assumed to be zero.
* Negative values are defined such that the text is moved past the text margin,
* positive values move the text inside the text margin.
@@ -1103,7 +1103,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* margin for this paragraph and the left edge of that paragraph's content
* in a left to right paragraph, and the right text margin and the right
* edge of that paragraph's text in a right to left paragraph
- *
* If this attribute is omitted, its value shall be assumed to be zero.
* Negative values are defined such that the text is moved past the text margin,
* positive values move the text inside the text margin.
@@ -1122,7 +1122,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* margin for this paragraph and the right edge of that paragraph's content
* in a left to right paragraph, and the right text margin and the right
* edge of that paragraph's text in a right to left paragraph
- *
* If this attribute is omitted, its value shall be assumed to be zero.
* Negative values are defined such that the text is moved past the text margin,
* positive values move the text inside the text margin.
@@ -1142,7 +1142,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* margin for this paragraph and the right edge of that paragraph's content
* in a left to right paragraph, and the right text margin and the right
* edge of that paragraph's text in a right to left paragraph
- *
* If this attribute is omitted, its value shall be assumed to be zero.
* Negative values are defined such that the text is moved past the text margin,
* positive values move the text inside the text margin.
@@ -1180,7 +1180,7 @@ public class XWPFParagraph implements IBodyElement, IRunBody, ISDTContents, Para
* towards the beginning of the direction of text flow.
* This indentation is specified relative to the paragraph indentation which is specified for
* all other lines in the parent paragraph.
- *
* The firstLine and hanging attributes are mutually exclusive, if both are specified, then the
* firstLine value is ignored.
*
* Note, that this call might be expensive since all the picture data is copied into a temporary byte array.
* You can grab the picture data directly from the underlying package part as follows:
- *
+ *
* This formatting property is a toggle property, which specifies that its
* behavior differs between its use within a style definition and its use as
* direct formatting. When used as part of a style definition, setting this
@@ -384,7 +384,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun {
* direct formatting, setting this property to true or false shall set the
* absolute state of the resulting property.
*
* If this element is not present, the default value is to leave the
* formatting applied at previous level in the style hierarchy. If this
* element is never applied in the style hierarchy, then bold shall not be
@@ -417,8 +417,8 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun {
/**
* Specifies that the contents of this run should be displayed along with an
* underline appearing directly below the character heigh
- *
+ *
* If this element is not present, the default value is to leave the
* formatting applied at previous level in the style hierarchy. If this
* element is never applied in the style hierarchy, then an underline shall
@@ -451,7 +451,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun {
/**
* Specifies that the contents of this run shall be displayed with a single
* horizontal line through the center of the line.
- *
* This formatting property is a toggle property, which specifies that its
* behaviour differs between its use within a style definition and its use as
* direct formatting. When used as part of a style definition, setting this
@@ -462,7 +462,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun {
* formatting, setting this property to true or false shall set the absolute
* state of the resulting property.
*
* If this element is not present, the default value is to leave the
* formatting applied at previous level in the style hierarchy. If this
* element is never applied in the style hierarchy, then strikethrough shall
@@ -597,7 +597,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun {
* run in relation to the default appearance of the run's text. This allows
* the text to be repositioned as subscript or superscript without altering
* the font size of the run properties.
- *
* If this element is not present, the default value is to leave the
* formatting applied at previous level in the style hierarchy. If this
* element is never applied in the style hierarchy, then the text shall not
@@ -666,7 +666,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun {
* Specifies the fonts which shall be used to display the text contents of
* this run. Specifies a font which shall be used to format all characters
* in the ASCII range (0 - 127) within the parent run.
- *
* Also sets the other font ranges, if they haven't been set before
*
* @param fontFamily
@@ -764,7 +764,7 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun {
/**
* Specifies the font size which shall be applied to all non complex script
* characters in the contents of this run when displayed.
- *
* If this element is not present, the default value is to leave the value
* applied at previous level in the style hierarchy. If this element is
* never applied in the style hierarchy, then any appropriate font size may
@@ -799,14 +799,14 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun {
* lowered for this run in relation to the default baseline of the
* surrounding non-positioned text. This allows the text to be repositioned
* without altering the font size of the contents.
- *
* If the val attribute is positive, then the parent run shall be raised
* above the baseline of the surrounding text by the specified number of
* half-points. If the val attribute is negative, then the parent run shall
* be lowered below the baseline of the surrounding text by the specified
* number of half-points.
*
* If this element is not present, the default value is to leave the
* formatting applied at previous level in the style hierarchy. If this
* element is never applied in the style hierarchy, then the text shall not
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDT.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDT.java
index 355527019..0f876357c 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDT.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDT.java
@@ -22,7 +22,7 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtRun;
/**
* Experimental class to offer rudimentary read-only processing of
* of StructuredDocumentTags/ContentControl
- *
* WARNING - APIs expected to change rapidly
*/
public class XWPFSDT extends AbstractXWPFSDT
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTCell.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTCell.java
index 83548f7f2..438303c40 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTCell.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTCell.java
@@ -22,9 +22,9 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtCell;
* Experimental class to offer rudimentary read-only processing of
* of StructuredDocumentTags/ContentControl that can appear
* in a table row as if a table cell.
- *
* These can contain one or more cells or other SDTs within them.
- *
* WARNING - APIs expected to change rapidly
*/
public class XWPFSDTCell extends AbstractXWPFSDT implements ICell {
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTContent.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTContent.java
index 4aab79499..b75352c51 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTContent.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTContent.java
@@ -31,9 +31,9 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTTbl;
/**
* Experimental class to offer rudimentary read-only processing of
* of the contentblock of an SDT/ContentControl.
- *
+ *
+ *
* WARNING - APIs expected to change rapidly
*/
public class XWPFSDTContent implements ISDTContent {
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.java
index 74645dc67..8432b39d2 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSDTContentCell.java
@@ -27,7 +27,7 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTSdtContentCell;
/**
* Experimental class to offer rudimentary read-only processing of
* of the XWPFSDTCellContent.
- *
* WARNING - APIs expected to change rapidly
*/
public class XWPFSDTContentCell implements ISDTContent {
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java
index 559c73f0c..626c180a9 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFSettings.java
@@ -67,10 +67,10 @@ public class XWPFSettings extends POIXMLDocumentPart {
}
/**
- * Set zoom.
+ *
+ *
* NOTICES:
*
* To get all text within a table, see XWPFWordExtractor's appendTableText
* as an example.
*
diff --git a/src/ooxml/testcases/org/apache/poi/openxml4j/opc/TestFileHelper.java b/src/ooxml/testcases/org/apache/poi/openxml4j/opc/TestFileHelper.java
index 72dc40cee..f22c78790 100644
--- a/src/ooxml/testcases/org/apache/poi/openxml4j/opc/TestFileHelper.java
+++ b/src/ooxml/testcases/org/apache/poi/openxml4j/opc/TestFileHelper.java
@@ -33,7 +33,7 @@ import org.junit.Test;
public final class TestFileHelper {
/**
- * TODO - use simple JDK methods on {@link File} instead:
* The author of this has added {@link CoreProperties#getKeywords()} and
* {@link CoreProperties#setKeywords(String)} and this test is supposed to test
* them.
diff --git a/src/ooxml/testcases/org/apache/poi/xwpf/TestPackageCorePropertiesGetKeywords.java b/src/ooxml/testcases/org/apache/poi/xwpf/TestPackageCorePropertiesGetKeywords.java
index d53c5c14d..1948c4754 100644
--- a/src/ooxml/testcases/org/apache/poi/xwpf/TestPackageCorePropertiesGetKeywords.java
+++ b/src/ooxml/testcases/org/apache/poi/xwpf/TestPackageCorePropertiesGetKeywords.java
@@ -29,7 +29,7 @@ import org.apache.poi.xwpf.usermodel.XWPFDocument;
* submitted because even though the
* {@link PackageProperties#getKeywordsProperty()} had been present before, the
* {@link CoreProperties#getKeywords()} had been missing.
- *
* The author of this has added {@link CoreProperties#getKeywords()} and
* {@link CoreProperties#setKeywords(String)} and this test is supposed to test
* them.
diff --git a/src/scratchpad/src/org/apache/poi/hslf/record/SSSlideInfoAtom.java b/src/scratchpad/src/org/apache/poi/hslf/record/SSSlideInfoAtom.java
index b087b66b0..fc6b3795a 100644
--- a/src/scratchpad/src/org/apache/poi/hslf/record/SSSlideInfoAtom.java
+++ b/src/scratchpad/src/org/apache/poi/hslf/record/SSSlideInfoAtom.java
@@ -24,12 +24,12 @@ import org.apache.poi.util.LittleEndian;
import org.apache.poi.util.LittleEndianConsts;
/**
- * A SlideShowSlideInfo Atom (type 1017).
* Useful for verifying that the serialisation round trip
*/
public static HSLFSlideShowImpl writeOutAndReadBack(HSLFSlideShowImpl original) {
@@ -70,7 +70,7 @@ public class HSLFTestDataSamples {
/**
* Writes a slideshow to a ByteArrayOutputStream and reads it back
- * from a ByteArrayInputStream.
* Useful for verifying that the serialisation round trip
*/
public static HSLFSlideShow writeOutAndReadBack(HSLFSlideShow original) {
diff --git a/src/scratchpad/testcases/org/apache/poi/hwpf/HWPFTestDataSamples.java b/src/scratchpad/testcases/org/apache/poi/hwpf/HWPFTestDataSamples.java
index 9cefffa01..997844778 100644
--- a/src/scratchpad/testcases/org/apache/poi/hwpf/HWPFTestDataSamples.java
+++ b/src/scratchpad/testcases/org/apache/poi/hwpf/HWPFTestDataSamples.java
@@ -155,7 +155,7 @@ public class HWPFTestDataSamples {
}
/**
* Writes a spreadsheet to a ByteArrayOutputStream and reads it back
- * from a ByteArrayInputStream.
* Useful for verifying that the serialisation round trip
*/
public static HWPFDocument writeOutAndReadBack(HWPFDocument original) {
diff --git a/src/testcases/org/apache/poi/AllPOITests.java b/src/testcases/org/apache/poi/AllPOITests.java
index 0fba8f828..40454c047 100644
--- a/src/testcases/org/apache/poi/AllPOITests.java
+++ b/src/testcases/org/apache/poi/AllPOITests.java
@@ -25,7 +25,7 @@ import org.apache.poi.util.AllPOIUtilTests;
import org.junit.runner.RunWith;
import org.junit.runners.Suite;
/**
- * Root Test Suite for entire POI project. (Includes all sub-packages of org.apache.poi)
* Useful for verifying that the serialisation round trip
*/
public static HSSFWorkbook writeOutAndReadBack(HSSFWorkbook original) {
diff --git a/src/testcases/org/apache/poi/hssf/HSSFTests.java b/src/testcases/org/apache/poi/hssf/HSSFTests.java
index 28602758e..fa87897da 100644
--- a/src/testcases/org/apache/poi/hssf/HSSFTests.java
+++ b/src/testcases/org/apache/poi/hssf/HSSFTests.java
@@ -30,7 +30,7 @@ import org.junit.runner.RunWith;
import org.junit.runners.Suite;
/**
- * Test Suite for all sub-packages of org.apache.poi.hssf
*
* Prior to the fix for bug 44675 POI would encode FuncVarPtg for all functions. In many cases
* Excel tolerates the wrong Ptg and evaluates the formula OK (e.g. SIN), but in some cases
@@ -1544,7 +1544,7 @@ public final class TestFormulaParser {
/**
* Zero is not a valid row number so cell references like 'A0' are not valid.
* Actually, they should be treated like defined names.
- *
*/
@Test
public void testUncalcSize_bug45066() {
@@ -498,7 +498,7 @@ public final class TestSheet {
/**
* Prior to bug 45145 RowRecordsAggregate and ValueRecordsAggregate could
* sometimes occur in reverse order. This test reproduces one of those situations and makes
- * sure that RRA comes before VRA.
* @throws IOException
*/
public void testReadWriteDBExtRefUncVol() throws IOException
@@ -233,7 +233,7 @@ public class TestDConRefRecord extends TestCase
/**
* test read-constructor-then-serialize for a double-byte self-reference style string
- *
* @throws IOException
*/
public void testReadWriteDBSelfRef() throws IOException
@@ -243,7 +243,7 @@ public class TestDConRefRecord extends TestCase
/**
* test read-constructor-then-serialize for a single-byte self-reference style string
- *
* @throws IOException
*/
public void testReadWriteSBSelfRef() throws IOException
diff --git a/src/testcases/org/apache/poi/hssf/record/TestEmbeddedObjectRefSubRecord.java b/src/testcases/org/apache/poi/hssf/record/TestEmbeddedObjectRefSubRecord.java
index 6d0a0fc80..fc12c98e2 100644
--- a/src/testcases/org/apache/poi/hssf/record/TestEmbeddedObjectRefSubRecord.java
+++ b/src/testcases/org/apache/poi/hssf/record/TestEmbeddedObjectRefSubRecord.java
@@ -145,7 +145,7 @@ public final class TestEmbeddedObjectRefSubRecord extends TestCase {
public void testVisioDrawing_bug46199() {
/**
- * taken from ftPictFmla sub-record in attachment 22860 (stream offset 0x768F).
*
* Notes on how to produce the test spreadsheet:
* Each test has four parts: The expected result (column A), the format string
* (column B), the value to format (column C), and a comma-separated list of
* categores that this test falls in. Normally all tests are run, but if the
diff --git a/src/testcases/org/apache/poi/ss/formula/EvaluationListener.java b/src/testcases/org/apache/poi/ss/formula/EvaluationListener.java
index babbbf62c..3524c3f7d 100644
--- a/src/testcases/org/apache/poi/ss/formula/EvaluationListener.java
+++ b/src/testcases/org/apache/poi/ss/formula/EvaluationListener.java
@@ -20,7 +20,7 @@ package org.apache.poi.ss.formula;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Tests should extend this class if they need to track the internal working of the {@link WorkbookEvaluator}.
* Note - the original diagnosis of bug 47198 was that
* "Excel considers -0.0 to be equal to 0.0" which is NQR
* See {@link TestMinusZeroResult} for more specific tests regarding -0.0.
diff --git a/src/testcases/org/apache/poi/ss/formula/eval/TestFormulaBugs.java b/src/testcases/org/apache/poi/ss/formula/eval/TestFormulaBugs.java
index 720ba5bea..a5d991bf7 100644
--- a/src/testcases/org/apache/poi/ss/formula/eval/TestFormulaBugs.java
+++ b/src/testcases/org/apache/poi/ss/formula/eval/TestFormulaBugs.java
@@ -29,13 +29,13 @@ import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
/**
- * Miscellaneous tests for bugzilla entries. The test name contains the
* bugzilla bug id.
*/
public final class TestFormulaBugs {
/**
- * Bug 27349 - VLOOKUP with reference to another sheet. This test was
* added long after the relevant functionality was fixed.
*/
@Test
@@ -66,7 +66,7 @@ public final class TestFormulaBugs {
}
/**
- * Bug 27405 - isnumber() formula always evaluates to false in if statement
*
* seems to be a duplicate of 24925
*/
@@ -117,7 +117,7 @@ public final class TestFormulaBugs {
}
/**
- * Bug 42448 - Can't parse SUMPRODUCT(A!C7:A!C67, B8:B68) / B69
*/
@Test
public void test42448() throws IOException {
diff --git a/src/testcases/org/apache/poi/ss/formula/eval/TestFormulasFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/eval/TestFormulasFromSpreadsheet.java
index 9ce0488f9..87b1fed4a 100644
--- a/src/testcases/org/apache/poi/ss/formula/eval/TestFormulasFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/eval/TestFormulasFromSpreadsheet.java
@@ -46,7 +46,7 @@ import org.junit.runners.Parameterized.Parameters;
import junit.framework.AssertionFailedError;
/**
- * Tests formulas and operators as loaded from a test data spreadsheet.
* This class does not test implementors of Function and OperationEval in
* isolation. Much of the evaluation engine (i.e. HSSFFormulaEvaluator, ...) gets
* exercised as well. Tests for bug fixes and specific/tricky behaviour can be found in the
diff --git a/src/testcases/org/apache/poi/ss/formula/eval/TestMinusZeroResult.java b/src/testcases/org/apache/poi/ss/formula/eval/TestMinusZeroResult.java
index 7500be57e..55ac409b2 100644
--- a/src/testcases/org/apache/poi/ss/formula/eval/TestMinusZeroResult.java
+++ b/src/testcases/org/apache/poi/ss/formula/eval/TestMinusZeroResult.java
@@ -28,7 +28,7 @@ import org.apache.poi.util.HexDump;
* Negative zero is not easy to observe in Excel, since it is usually converted to 0.0.
* (Note - the results of XLL add-in functions don't seem to be converted, so they are one
* reliable avenue to observe Excel's treatment of '-0.0' as an operand.)
- *
* POI attempts to emulate Excel faithfully, so this class tests
* two aspects of '-0.0' in formula evaluation:
*
* Assumes that the cell coordinate parameters of
*
* This method cannot be used for confirming error return codes. Any non-numeric evaluation
* result causes the current junit test to fail.
*/
@@ -56,7 +56,7 @@ public final class NumericFunctionInvoker {
}
/**
* Invokes the specified operator with the arguments.
- *
* This method cannot be used for confirming error return codes. Any non-numeric evaluation
* result causes the current junit test to fail.
*/
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestCodeFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestCodeFunctionsFromSpreadsheet.java
index 8cc6ea3b1..1d2e2cf0a 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestCodeFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestCodeFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests CODE() as loaded from a test data spreadsheet.
*/
public class TestCodeFunctionsFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestComplexFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestComplexFunctionsFromSpreadsheet.java
index 760974c28..f16246fd1 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestComplexFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestComplexFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests COMPLEX() as loaded from a test data spreadsheet.
*/
public class TestComplexFunctionsFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestDeltaFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestDeltaFunctionsFromSpreadsheet.java
index d469f930a..f1725d70b 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestDeltaFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestDeltaFunctionsFromSpreadsheet.java
@@ -21,7 +21,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests DELTA() as loaded from a test data spreadsheet.
*/
public class TestDeltaFunctionsFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestFactDoubleFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestFactDoubleFunctionsFromSpreadsheet.java
index df3001e89..2d21db226 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestFactDoubleFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestFactDoubleFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests FactDouble() as loaded from a test data spreadsheet.
*/
public class TestFactDoubleFunctionsFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestImRealFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestImRealFunctionsFromSpreadsheet.java
index 88f27a19e..4fcd93759 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestImRealFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestImRealFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests ImReal() as loaded from a test data spreadsheet.
*/
public class TestImRealFunctionsFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestImaginaryFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestImaginaryFunctionsFromSpreadsheet.java
index 7fe71ce62..cb0389431 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestImaginaryFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestImaginaryFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests Imaginary() as loaded from a test data spreadsheet.
*/
public class TestImaginaryFunctionsFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestIndex.java b/src/testcases/org/apache/poi/ss/formula/functions/TestIndex.java
index ce0325285..799a3af1a 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestIndex.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestIndex.java
@@ -33,9 +33,9 @@ import org.apache.poi.ss.util.CellRangeAddress;
* Tests for the INDEX() function.
*/
public final class TestIndexFunctionFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestIndirectFunctionFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestIndirectFunctionFromSpreadsheet.java
index a78b5fd5e..5df83b43b 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestIndirectFunctionFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestIndirectFunctionFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests INDIRECT() as loaded from a test data spreadsheet.
*
* Tests for bug fixes and specific/tricky behaviour can be found in the corresponding test class
* (TestXxxx) of the target (Xxxx) implementor, where execution can be observed
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestLookupFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestLookupFunctionsFromSpreadsheet.java
index 6d95561d5..d3c27ce1d 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestLookupFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestLookupFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests lookup functions (VLOOKUP, HLOOKUP, LOOKUP, MATCH) as loaded from a test data spreadsheet.
* These tests have been separated from the common function and operator tests because the lookup
* functions have more complex test cases and test data setup.
*
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestMatch.java b/src/testcases/org/apache/poi/ss/formula/functions/TestMatch.java
index 40731e21a..9659bccd9 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestMatch.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestMatch.java
@@ -229,7 +229,7 @@ public final class TestMatch extends TestCase {
/**
- * Ensures that the match_type argument can be an AreaEval.
*
* Tests for bug fixes and specific/tricky behaviour can be found in the corresponding test class
* (TestXxxx) of the target (Xxxx) implementor, where execution can be observed
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestQuotientFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestQuotientFunctionsFromSpreadsheet.java
index 146e0cf90..5f33111a3 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestQuotientFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestQuotientFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests QUOTIENT() as loaded from a test data spreadsheet.
*/
public class TestQuotientFunctionsFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestReptFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestReptFunctionsFromSpreadsheet.java
index e1d26ff63..f505cd556 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestReptFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestReptFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests REPT() as loaded from a test data spreadsheet.
*/
public class TestReptFunctionsFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestRomanFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestRomanFunctionsFromSpreadsheet.java
index 7f6ca4ea6..26b8745cf 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestRomanFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestRomanFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests Roman() as loaded from a test data spreadsheet.
*/
public class TestRomanFunctionsFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestWeekNumFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestWeekNumFunctionsFromSpreadsheet.java
index cf70a993d..8fd8cef82 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestWeekNumFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestWeekNumFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests WeekNum() as loaded from a test data spreadsheet.
*/
public class TestWeekNumFunctionsFromSpreadsheet extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestWeekNumFunctionsFromSpreadsheet2013.java b/src/testcases/org/apache/poi/ss/formula/functions/TestWeekNumFunctionsFromSpreadsheet2013.java
index 6d104efca..ccffa6f59 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestWeekNumFunctionsFromSpreadsheet2013.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestWeekNumFunctionsFromSpreadsheet2013.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests WeekNum() as loaded from a test data 2013 excel spreadsheet.
*/
public class TestWeekNumFunctionsFromSpreadsheet2013 extends BaseTestFunctionsFromSpreadsheet {
@Parameters(name="{0}")
diff --git a/src/testcases/org/apache/poi/ss/usermodel/BaseTestNamedRange.java b/src/testcases/org/apache/poi/ss/usermodel/BaseTestNamedRange.java
index 21a43ae20..b858e3dd1 100644
--- a/src/testcases/org/apache/poi/ss/usermodel/BaseTestNamedRange.java
+++ b/src/testcases/org/apache/poi/ss/usermodel/BaseTestNamedRange.java
@@ -562,7 +562,7 @@ public abstract class BaseTestNamedRange {
* It is easy enough to re-create the the same data (by not setting the formula). Excel
* seems to gracefully remove this uninitialized name record. It would be nice if POI
* could do the same, but that would involve adjusting subsequent name indexes across
- * all formulas.
*
* For the moment, POI has been made to behave more sensibly with uninitialized name
* records.
diff --git a/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheetUpdateArrayFormulas.java b/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheetUpdateArrayFormulas.java
index bbd95cccd..bbc9ab7e7 100644
--- a/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheetUpdateArrayFormulas.java
+++ b/src/testcases/org/apache/poi/ss/usermodel/BaseTestSheetUpdateArrayFormulas.java
@@ -38,7 +38,7 @@ import org.junit.Ignore;
import org.junit.Test;
/**
- * Common superclass for testing usermodel API for array formulas.
*
* There are multiple encodings (bit patterns) for NaN, and CPUs and applications can convert
* to a preferred NaN encoding (Java prefers 0x7FF8000000000000L). Besides the
@@ -99,10 +99,10 @@ public final class TestNumberToTextConverter extends TestCase {
* Observed NaN behaviour on HotSpot/Windows:
* Double.longBitsToDouble() will set one bit 51 (the NaN signaling flag) if it isn't
* already. Double.doubleToLongBits() will return a double with bit pattern
- * 0x7FF8000000000000L for any NaN bit pattern supplied.
*
- *
* The few test case examples calling this method represent functionality which may not be
* important for POI to support.
*/
diff --git a/src/testcases/org/apache/poi/util/AllPOIUtilTests.java b/src/testcases/org/apache/poi/util/AllPOIUtilTests.java
index f018b0229..58155e6dc 100644
--- a/src/testcases/org/apache/poi/util/AllPOIUtilTests.java
+++ b/src/testcases/org/apache/poi/util/AllPOIUtilTests.java
@@ -21,7 +21,7 @@ import org.junit.runner.RunWith;
import org.junit.runners.Suite;
/**
- * Test suite for all sub-packages of org.apache.poi.util
+ * Finishes writing the current record and updates 'ushort size' field.
* After this method is called, only {@link #getTotalSize()} may be called.
*/
public void terminate() {
diff --git a/src/java/org/apache/poi/hssf/record/pivottable/DataItemRecord.java b/src/java/org/apache/poi/hssf/record/pivottable/DataItemRecord.java
index 05cf6a675..936747579 100644
--- a/src/java/org/apache/poi/hssf/record/pivottable/DataItemRecord.java
+++ b/src/java/org/apache/poi/hssf/record/pivottable/DataItemRecord.java
@@ -24,7 +24,7 @@ import org.apache.poi.util.LittleEndianOutput;
import org.apache.poi.util.StringUtil;
/**
- * SXDI - Data Item (0x00C5)
+ * SXDI - Data Item (0x00C5)
*
* @author Patrick Cheng
*/
diff --git a/src/java/org/apache/poi/hssf/record/pivottable/ExtendedPivotTableViewFieldsRecord.java b/src/java/org/apache/poi/hssf/record/pivottable/ExtendedPivotTableViewFieldsRecord.java
index 22d6b0d37..87baf1492 100644
--- a/src/java/org/apache/poi/hssf/record/pivottable/ExtendedPivotTableViewFieldsRecord.java
+++ b/src/java/org/apache/poi/hssf/record/pivottable/ExtendedPivotTableViewFieldsRecord.java
@@ -25,7 +25,7 @@ import org.apache.poi.util.RecordFormatException;
import org.apache.poi.util.StringUtil;
/**
- * SXVDEX - Extended PivotTable View Fields (0x0100)
+ * SXVDEX - Extended PivotTable View Fields (0x0100)
*
* @author Patrick Cheng
*/
diff --git a/src/java/org/apache/poi/hssf/record/pivottable/PageItemRecord.java b/src/java/org/apache/poi/hssf/record/pivottable/PageItemRecord.java
index a23cb4239..a41d2ca03 100644
--- a/src/java/org/apache/poi/hssf/record/pivottable/PageItemRecord.java
+++ b/src/java/org/apache/poi/hssf/record/pivottable/PageItemRecord.java
@@ -24,7 +24,7 @@ import org.apache.poi.util.LittleEndianOutput;
import org.apache.poi.util.RecordFormatException;
/**
- * SXPI - Page Item (0x00B6)
+ * SXPI - Page Item (0x00B6)
*
* @author Patrick Cheng
*/
diff --git a/src/java/org/apache/poi/hssf/record/pivottable/StreamIDRecord.java b/src/java/org/apache/poi/hssf/record/pivottable/StreamIDRecord.java
index bd7290078..034070fe1 100644
--- a/src/java/org/apache/poi/hssf/record/pivottable/StreamIDRecord.java
+++ b/src/java/org/apache/poi/hssf/record/pivottable/StreamIDRecord.java
@@ -23,7 +23,7 @@ import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndianOutput;
/**
- * SXIDSTM - Stream ID (0x00D5)
+ * SXIDSTM - Stream ID (0x00D5)
*
* @author Patrick Cheng
*/
diff --git a/src/java/org/apache/poi/hssf/record/pivottable/ViewDefinitionRecord.java b/src/java/org/apache/poi/hssf/record/pivottable/ViewDefinitionRecord.java
index 3c37924f9..c14403ece 100644
--- a/src/java/org/apache/poi/hssf/record/pivottable/ViewDefinitionRecord.java
+++ b/src/java/org/apache/poi/hssf/record/pivottable/ViewDefinitionRecord.java
@@ -24,7 +24,7 @@ import org.apache.poi.util.LittleEndianOutput;
import org.apache.poi.util.StringUtil;
/**
- * SXVIEW - View Definition (0x00B0)
+ * SXVIEW - View Definition (0x00B0)
*/
public final class ViewDefinitionRecord extends StandardRecord {
public static final short sid = 0x00B0;
diff --git a/src/java/org/apache/poi/hssf/record/pivottable/ViewFieldsRecord.java b/src/java/org/apache/poi/hssf/record/pivottable/ViewFieldsRecord.java
index de73f8447..2003c9419 100644
--- a/src/java/org/apache/poi/hssf/record/pivottable/ViewFieldsRecord.java
+++ b/src/java/org/apache/poi/hssf/record/pivottable/ViewFieldsRecord.java
@@ -24,7 +24,7 @@ import org.apache.poi.util.LittleEndianOutput;
import org.apache.poi.util.StringUtil;
/**
- * SXVD - View Fields (0x00B1)
+ * SXVD - View Fields (0x00B1)
*
* @author Patrick Cheng
*/
diff --git a/src/java/org/apache/poi/hssf/record/pivottable/ViewSourceRecord.java b/src/java/org/apache/poi/hssf/record/pivottable/ViewSourceRecord.java
index daee00732..c956bb44b 100644
--- a/src/java/org/apache/poi/hssf/record/pivottable/ViewSourceRecord.java
+++ b/src/java/org/apache/poi/hssf/record/pivottable/ViewSourceRecord.java
@@ -23,7 +23,7 @@ import org.apache.poi.util.HexDump;
import org.apache.poi.util.LittleEndianOutput;
/**
- * SXVS - View Source (0x00E3)
+ * SXVS - View Source (0x00E3)
*
* @author Patrick Cheng
*/
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java b/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java
index a95ea239a..4d711f041 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java
@@ -806,7 +806,7 @@ public class HSSFCell implements Cell {
/**
- * Chooses a new boolean value for the cell when its type is changing.
+ * Chooses a new boolean value for the cell when its type is changing.
+ * International Formats
* Since version 2003 Excel has supported international formats. These are denoted
* with a prefix "[$-xxx]" (where xxx is a 1-7 digit hexadecimal number).
* See the Microsoft article
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
index 20c7ffa1e..e7d848202 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
@@ -36,7 +36,7 @@ import org.apache.poi.ss.usermodel.RichTextString;
import org.apache.poi.ss.usermodel.Workbook;
/**
- * Evaluates formula cells.resize(1.0,1.0)
keeps the original size,
- * resize(0.5,0.5)
resize to 50% of the original,
- * resize(2.0,2.0)
resizes to 200% of the original.
+ * resize(1.0,1.0)
keeps the original size,
+ * resize(0.5,0.5)
resize to 50% of the original,
+ * resize(2.0,2.0)
resizes to 200% of the original.
* resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})
resizes to the dimension of the embedded image.
*
* Truncate([numChars*7+5]/7*256)/256 = 8;
*
- *
+ * 7.29
.
*
* @param columnIndex - the column to set (0-based)
diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java b/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java
index d3aba5ba2..a753036bc 100644
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java
@@ -44,7 +44,7 @@ public final class HSSFSheetConditionalFormatting implements SheetConditionalFor
/**
* A factory method allowing to create a conditional formatting rule
- * with a cell comparison operator
*
- * The formatting rules are applied by Excel when the value of the formula not equal to 0.
+ * sheet. (For example when printing - see Bug 40414).
*
* This method makes sure that if the removed sheet was active, another sheet will become
* active in its place. Furthermore, if the removed sheet was the only selected sheet, another
diff --git a/src/java/org/apache/poi/hssf/util/AreaReference.java b/src/java/org/apache/poi/hssf/util/AreaReference.java
index 3e3b26e22..2bea3df3a 100644
--- a/src/java/org/apache/poi/hssf/util/AreaReference.java
+++ b/src/java/org/apache/poi/hssf/util/AreaReference.java
@@ -26,7 +26,7 @@ import org.apache.poi.ss.SpreadsheetVersion;
public final class AreaReference extends org.apache.poi.ss.util.AreaReference {
/**
* Create an area ref from a string representation. Sheet names containing special characters should be
- * delimited and escaped as per normal syntax rules for formulas.
+ * delimited and escaped as per normal syntax rules for formulas.
* The area reference must be contiguous (i.e. represent a single rectangle, not a union of rectangles)
*/
public AreaReference(String reference) {
diff --git a/src/java/org/apache/poi/hssf/util/CellRangeAddress8Bit.java b/src/java/org/apache/poi/hssf/util/CellRangeAddress8Bit.java
index 9c866f9b5..50a2ac2c1 100644
--- a/src/java/org/apache/poi/hssf/util/CellRangeAddress8Bit.java
+++ b/src/java/org/apache/poi/hssf/util/CellRangeAddress8Bit.java
@@ -22,7 +22,7 @@ import org.apache.poi.util.LittleEndianInput;
import org.apache.poi.util.LittleEndianOutput;
/**
- * See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'
+ *
* 2.3.4.11 Encryption Key Generation (Agile Encryption)
- *
+ *
* {@code blockKey: IV = H(KeySalt + blockKey)}
+ *
* {@code KeySalt:IV = KeySalt}true
* for markSupported()). In the unlikely case that the caller has such a stream
diff --git a/src/java/org/apache/poi/poifs/filesystem/OPOIFSFileSystem.java b/src/java/org/apache/poi/poifs/filesystem/OPOIFSFileSystem.java
index b0afaa333..9cdc38444 100644
--- a/src/java/org/apache/poi/poifs/filesystem/OPOIFSFileSystem.java
+++ b/src/java/org/apache/poi/poifs/filesystem/OPOIFSFileSystem.java
@@ -96,7 +96,7 @@ public class OPOIFSFileSystem
/**
* Create a OPOIFSFileSystem from an InputStream. Normally the stream is read until
- * EOF. The stream is always closed.true
* for markSupported()). In the unlikely case that the caller has such a stream
diff --git a/src/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java b/src/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java
index c4ff36272..71e6ce117 100644
--- a/src/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java
+++ b/src/java/org/apache/poi/poifs/filesystem/POIFSFileSystem.java
@@ -52,7 +52,7 @@ public class POIFSFileSystem
/**
* Create a POIFSFileSystem from an InputStream. Normally the stream is read until
- * EOF. The stream is always closed.true
* for markSupported()). In the unlikely case that the caller has such a stream
diff --git a/src/java/org/apache/poi/poifs/storage/BlockAllocationTableReader.java b/src/java/org/apache/poi/poifs/storage/BlockAllocationTableReader.java
index df872b3a7..b96ec2088 100644
--- a/src/java/org/apache/poi/poifs/storage/BlockAllocationTableReader.java
+++ b/src/java/org/apache/poi/poifs/storage/BlockAllocationTableReader.java
@@ -45,7 +45,7 @@ public final class BlockAllocationTableReader {
/**
* Maximum number size (in blocks) of the allocation table as supported by
- * POI.
+ * POI.
*
* This constant has been chosen to help POI identify corrupted data in the
* header block (rather than crash immediately with {@link OutOfMemoryError}
diff --git a/src/java/org/apache/poi/poifs/storage/DataInputBlock.java b/src/java/org/apache/poi/poifs/storage/DataInputBlock.java
index 0710b4ee7..ebdc7552b 100644
--- a/src/java/org/apache/poi/poifs/storage/DataInputBlock.java
+++ b/src/java/org/apache/poi/poifs/storage/DataInputBlock.java
@@ -20,13 +20,13 @@ package org.apache.poi.poifs.storage;
/**
* Wraps a byte array and provides simple data input access.
* Internally, this class maintains a buffer read index, so that for the most part, primitive
- * data can be read in a data-input-stream-like manner.
+ * Stores the parameters that identify the evaluation of one cell.
*/
abstract class CellCacheEntry implements ICacheEntry {
public static final CellCacheEntry[] EMPTY_ARRAY = { };
diff --git a/src/java/org/apache/poi/ss/formula/CellEvaluationFrame.java b/src/java/org/apache/poi/ss/formula/CellEvaluationFrame.java
index 2f9c9521f..1d08eac1b 100644
--- a/src/java/org/apache/poi/ss/formula/CellEvaluationFrame.java
+++ b/src/java/org/apache/poi/ss/formula/CellEvaluationFrame.java
@@ -23,7 +23,7 @@ import java.util.Set;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Stores details about the current evaluation of a cell.
+ * Stores details about the current evaluation of a cell.
*/
final class CellEvaluationFrame {
diff --git a/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java b/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
index adabc09f5..21508caab 100644
--- a/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
+++ b/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
@@ -36,12 +36,12 @@ import org.apache.poi.ss.util.CellReference;
import org.apache.poi.ss.util.SheetUtil;
/**
- * Evaluates Conditional Formatting constraints.CTCfRule
in XSSFConditionalFormattingRule
.
- * CTCfRule
in XSSFConditionalFormattingRule
.
- *
+ * and non-formula cells.
*
* For POI internal use only
*
diff --git a/src/java/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.java b/src/java/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.java
index 477aaaf64..48b7243e9 100644
--- a/src/java/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.java
+++ b/src/java/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.java
@@ -51,12 +51,12 @@ import org.apache.poi.ss.util.CellRangeAddress;
* {@link ConditionalFormattingEvaluator}. This references a rule, its owning
* {@link ConditionalFormatting}, its priority order (lower index = higher priority in Excel),
* and the information needed to evaluate the rule for a given cell.
- *
+ * Abstracts a name record for formula evaluation.
*
* For POI internal use only
*
diff --git a/src/java/org/apache/poi/ss/formula/EvaluationSheet.java b/src/java/org/apache/poi/ss/formula/EvaluationSheet.java
index 1d5b0655a..b3e60e2b3 100644
--- a/src/java/org/apache/poi/ss/formula/EvaluationSheet.java
+++ b/src/java/org/apache/poi/ss/formula/EvaluationSheet.java
@@ -20,7 +20,7 @@ package org.apache.poi.ss.formula;
import org.apache.poi.util.Internal;
/**
- * Abstracts a sheet for the purpose of formula evaluation.
+ * Abstracts a sheet for the purpose of formula evaluation.
*
* For POI internal use only
*
diff --git a/src/java/org/apache/poi/ss/formula/EvaluationTracker.java b/src/java/org/apache/poi/ss/formula/EvaluationTracker.java
index ef7cb1187..bb21e4a8c 100644
--- a/src/java/org/apache/poi/ss/formula/EvaluationTracker.java
+++ b/src/java/org/apache/poi/ss/formula/EvaluationTracker.java
@@ -49,16 +49,16 @@ final class EvaluationTracker {
/**
* Notifies this evaluation tracker that evaluation of the specified cell is
- * about to start.
+ * about to start.
*
* In the case of a true
return code, the caller should
* continue evaluation of the specified cell, and also be sure to call
- * endEvaluate() when complete.
+ * endEvaluate() when complete.
*
* In the case of a null
return code, the caller should
* return an evaluation result of
* ErrorEval.CIRCULAR_REF_ERROR, and not call endEvaluate().
- *
+ *
* @return false
if the specified cell is already being evaluated
*/
public boolean startEvaluate(FormulaCellCacheEntry cce) {
@@ -94,10 +94,10 @@ final class EvaluationTracker {
}
/**
- * Notifies this evaluation tracker that the evaluation of the specified cell is complete.
+ * Abstracts a workbook for the purpose of formula evaluation.
*
* For POI internal use only
*
diff --git a/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java b/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java
index ce67dadc1..ce6bf0efd 100644
--- a/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java
+++ b/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java
@@ -18,7 +18,7 @@
package org.apache.poi.ss.formula;
/**
- * Should be implemented by any {@link org.apache.poi.ss.formula.ptg.Ptg} subclass that needs has an extern sheet index
+ * Should be implemented by any {@link org.apache.poi.ss.formula.ptg.Ptg} subclass that needs has an extern sheet index
*
* For POI internal use only
*
diff --git a/src/java/org/apache/poi/ss/formula/FormulaParser.java b/src/java/org/apache/poi/ss/formula/FormulaParser.java
index 7af8668b2..8d0653b02 100644
--- a/src/java/org/apache/poi/ss/formula/FormulaParser.java
+++ b/src/java/org/apache/poi/ss/formula/FormulaParser.java
@@ -87,9 +87,9 @@ import org.apache.poi.util.POILogger;
*
+ * Abstracts a workbook for the purpose of formula parsing.
*
* For POI internal use only
*
diff --git a/src/java/org/apache/poi/ss/formula/FormulaRenderer.java b/src/java/org/apache/poi/ss/formula/FormulaRenderer.java
index 1d1c7313c..208f55918 100644
--- a/src/java/org/apache/poi/ss/formula/FormulaRenderer.java
+++ b/src/java/org/apache/poi/ss/formula/FormulaRenderer.java
@@ -28,7 +28,7 @@ import org.apache.poi.ss.formula.ptg.ParenthesisPtg;
import org.apache.poi.ss.formula.ptg.Ptg;
/**
- * Common logic for rendering formulas.
+ * Common logic for rendering formulas.
*
* For POI internal use only
*
diff --git a/src/java/org/apache/poi/ss/formula/FormulaRenderingWorkbook.java b/src/java/org/apache/poi/ss/formula/FormulaRenderingWorkbook.java
index f918be4eb..94b791d31 100644
--- a/src/java/org/apache/poi/ss/formula/FormulaRenderingWorkbook.java
+++ b/src/java/org/apache/poi/ss/formula/FormulaRenderingWorkbook.java
@@ -22,7 +22,7 @@ import org.apache.poi.ss.formula.ptg.NamePtg;
import org.apache.poi.ss.formula.ptg.NameXPtg;
/**
- * Abstracts a workbook for the purpose of converting formula to text.
+ * Abstracts a workbook for the purpose of converting formula to text.
*
* For POI internal use only
*
diff --git a/src/java/org/apache/poi/ss/formula/IEvaluationListener.java b/src/java/org/apache/poi/ss/formula/IEvaluationListener.java
index bab3ba325..6182a28cf 100644
--- a/src/java/org/apache/poi/ss/formula/IEvaluationListener.java
+++ b/src/java/org/apache/poi/ss/formula/IEvaluationListener.java
@@ -20,7 +20,7 @@ package org.apache.poi.ss.formula;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Tests can implement this class to track the internal working of the {@link WorkbookEvaluator}.
+ * Tests can implement this class to track the internal working of the {@link WorkbookEvaluator}.
*
* For POI internal testing use only
*
diff --git a/src/java/org/apache/poi/ss/formula/IStabilityClassifier.java b/src/java/org/apache/poi/ss/formula/IStabilityClassifier.java
index 089469bc6..db8beac9b 100644
--- a/src/java/org/apache/poi/ss/formula/IStabilityClassifier.java
+++ b/src/java/org/apache/poi/ss/formula/IStabilityClassifier.java
@@ -19,12 +19,12 @@ package org.apache.poi.ss.formula;
/**
* Used to help optimise cell evaluation result caching by allowing applications to specify which
- * parts of a workbook are final.
+ * parts of a workbook are final.
* The term final is introduced here to denote immutability or 'having constant definition'.
* This classification refers to potential actions (on the evaluated workbook) by the evaluating
* application. It does not refer to operations performed by the evaluator ({@link
- * WorkbookEvaluator}).
- *
+ * WorkbookEvaluator}).
+ *
* General guidelines:
*
*
- *
+ * Ptg
* tokens into human readable text form. In formula expressions, a sheet name always has a
* trailing '!' so there is little chance for ambiguity. It doesn't matter too much what this
@@ -177,7 +177,7 @@ public final class SheetNameFormatter {
*
* At the time of writing, POI's formula parser tolerates cell-like sheet names in formulas
* with or without delimiters. The same goes for Excel(2007), both manual and automated entry.
- *
diff --git a/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java b/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java
index 47dc952f7..59bd2a1a8 100644
--- a/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java
+++ b/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java
@@ -19,7 +19,7 @@ package org.apache.poi.ss.formula;
/**
* Should be implemented by any {@link org.apache.poi.ss.formula.ptg.Ptg} subclass that needs a workbook to render its formula.
- *
+ *
*
* For POI internal use only
*
diff --git a/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java b/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
index 89b73d025..7b870dc33 100644
--- a/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
+++ b/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
@@ -44,11 +44,11 @@ import org.apache.poi.util.Internal;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
/**
- * Evaluates formula cells.
+ * Evaluates formula cells.
+ * calls to evaluate~ methods on this class.
*
* For POI internal use only
*
@@ -595,7 +595,7 @@ public final class WorkbookEvaluator {
/**
* returns an appropriate Eval impl instance for the Ptg. The Ptg must be
* one of: Area3DPtg, AreaPtg, ReferencePtg, Ref3DPtg, IntPtg, NumberPtg,
- * StringPtg, BoolPtg
special Note: OperationPtg subtypes cannot be
+ * StringPtg, BoolPtg
special Note: OperationPtg subtypes cannot be
* passed here!
*/
private ValueEval getEvalForPtg(Ptg ptg, OperationEvaluationContext ec) {
diff --git a/src/java/org/apache/poi/ss/formula/atp/IfError.java b/src/java/org/apache/poi/ss/formula/atp/IfError.java
index d3a22661b..9e405e3c2 100644
--- a/src/java/org/apache/poi/ss/formula/atp/IfError.java
+++ b/src/java/org/apache/poi/ss/formula/atp/IfError.java
@@ -24,11 +24,11 @@ import org.apache.poi.ss.formula.eval.EvaluationException;
import org.apache.poi.ss.formula.eval.ValueEval;
import org.apache.poi.ss.formula.functions.FreeRefFunction;
/**
- * Implementation of 'Analysis Toolpak' Excel function IFERROR()
+ * Implementation of 'Analysis Toolpak' Excel function IFERROR()
*
- * Returns an error text if there is an error in the evaluation
+ * Syntax
* IFERROR(expression, string)
*
* @author Johan Karlsteen
diff --git a/src/java/org/apache/poi/ss/formula/atp/MRound.java b/src/java/org/apache/poi/ss/formula/atp/MRound.java
index 8ca8796ca..73f5ab320 100644
--- a/src/java/org/apache/poi/ss/formula/atp/MRound.java
+++ b/src/java/org/apache/poi/ss/formula/atp/MRound.java
@@ -23,14 +23,14 @@ import org.apache.poi.ss.formula.functions.FreeRefFunction;
import org.apache.poi.ss.formula.functions.NumericFunction;
/**
- * Implementation of Excel 'Analysis ToolPak' function MROUND()
+ * Implementation of Excel 'Analysis ToolPak' function MROUND()
*
- * Returns a number rounded to the desired multiple.
+ * Syntax
* MROUND(number, multiple)
*
- *
+ * Implementation of Excel 'Analysis ToolPak' function NETWORKDAYS()
* Returns the number of workdays given a starting and an ending date, considering an interval of holidays. A workday is any non
* saturday/sunday date.
- *
+ *
* NETWORKDAYS(startDate, endDate, holidays)
- *
+ * Implementation of Excel 'Analysis ToolPak' function ISEVEN() ISODD()
*
* @author Josh Micich
*/
diff --git a/src/java/org/apache/poi/ss/formula/atp/RandBetween.java b/src/java/org/apache/poi/ss/formula/atp/RandBetween.java
index 4da7a53ef..5eac08fe5 100644
--- a/src/java/org/apache/poi/ss/formula/atp/RandBetween.java
+++ b/src/java/org/apache/poi/ss/formula/atp/RandBetween.java
@@ -25,15 +25,15 @@ import org.apache.poi.ss.formula.functions.FreeRefFunction;
import org.apache.poi.ss.formula.OperationEvaluationContext;
/**
- * Implementation of Excel 'Analysis ToolPak' function RANDBETWEEN()
+ * Implementation of Excel 'Analysis ToolPak' function RANDBETWEEN()
*
- * Returns a random integer number between the numbers you specify.
- * RANDBETWEEN(bottom, top)
+ * RANDBETWEEN(bottom, top)
- * top is the largest integer RANDBETWEEN will return.
+ * bottom is the smallest integer RANDBETWEEN will return.
+ * top is the largest integer RANDBETWEEN will return.
* @author Brendan Nolan
*/
diff --git a/src/java/org/apache/poi/ss/formula/atp/WorkdayFunction.java b/src/java/org/apache/poi/ss/formula/atp/WorkdayFunction.java
index e746bd139..d4eff0261 100644
--- a/src/java/org/apache/poi/ss/formula/atp/WorkdayFunction.java
+++ b/src/java/org/apache/poi/ss/formula/atp/WorkdayFunction.java
@@ -26,13 +26,13 @@ import org.apache.poi.ss.formula.functions.FreeRefFunction;
import org.apache.poi.ss.usermodel.DateUtil;
/**
- * Implementation of Excel 'Analysis ToolPak' function WORKDAY()
+ * Implementation of Excel 'Analysis ToolPak' function WORKDAY()
* Returns the date past a number of workdays beginning at a start date, considering an interval of holidays. A workday is any non
* saturday/sunday date.
- *
+ *
* WORKDAY(startDate, days, holidays)
- *
+ * Implementation of Excel 'Analysis ToolPak' function YEARFRAC()
*
- * Returns the fraction of the year spanned by two dates.
- * YEARFRAC(startDate, endDate, basis)
+ * YEARFRAC(startDate, endDate, basis)
+ * Internal calculation methods for Excel 'Analysis ToolPak' function YEARFRAC()
*
* Algorithm inspired by www.dwheeler.com/yearfrac
*/
diff --git a/src/java/org/apache/poi/ss/formula/constant/ConstantValueParser.java b/src/java/org/apache/poi/ss/formula/constant/ConstantValueParser.java
index aa5016bc2..a4577bba0 100644
--- a/src/java/org/apache/poi/ss/formula/constant/ConstantValueParser.java
+++ b/src/java/org/apache/poi/ss/formula/constant/ConstantValueParser.java
@@ -24,7 +24,7 @@ import org.apache.poi.util.StringUtil;
/**
* To support Constant Values (2.5.7) as required by the CRN record.
* This class is also used for two dimensional arrays which are encoded by
- * EXTERNALNAME (5.39) records and Array tokens.
+ * Convenience method for the following:
* (b ? BoolEval.TRUE : BoolEval.FALSE)
*
* @return the BoolEval instance representing b.
diff --git a/src/java/org/apache/poi/ss/formula/eval/EvaluationException.java b/src/java/org/apache/poi/ss/formula/eval/EvaluationException.java
index bb9d9574b..e094df464 100644
--- a/src/java/org/apache/poi/ss/formula/eval/EvaluationException.java
+++ b/src/java/org/apache/poi/ss/formula/eval/EvaluationException.java
@@ -20,7 +20,7 @@ package org.apache.poi.ss.formula.eval;
/**
* This class is used to simplify error handling logic within operator and function
* implementations. Note - OperationEval.evaluate() and Function.evaluate()
- * method signatures do not throw this exception so it cannot propagate outside.
@@ -51,9 +51,9 @@ package org.apache.poi.ss.formula.eval;
*
* In this example, if any error is encountered while processing the arguments, an error is
* returned immediately. This code is difficult to refactor due to all the points where errors
- * are returned.
+ * are returned.
* Using EvaluationException allows the error returning code to be consolidated to one
- * place.
+ * place.
* public Eval evaluate(Eval[] args, int srcRow, short srcCol) {
* try {
@@ -91,14 +91,14 @@ package org.apache.poi.ss.formula.eval;
* return temp;
*}
*
- * It is not mandatory to use EvaluationException, doing so might give the following advantages:
- * - Methods can more easily be extracted, allowing for re-use.
+ * It is not mandatory to use EvaluationException, doing so might give the following advantages:
+ * - Methods can more easily be extracted, allowing for re-use.
* - Type management (typecasting etc) is simpler because error conditions have been separated from
- * intermediate calculation values.
- * - Fewer local variables are required. Local variables can have stronger types.
+ * intermediate calculation values.
+ * - Fewer local variables are required. Local variables can have stronger types.
* - It is easier to mimic common Excel error handling behaviour (exit upon encountering first
* error), because exceptions conveniently propagate up the call stack regardless of execution
- * points or the number of levels of nested calls.
+ * points or the number of levels of nested calls.
+ * Applies some conversion rules if the supplied value is not already an integer.
* Value is first coerced to a double ( See coerceValueToDouble() ).
- * Note - BlankEval is converted to 0
.0
.
- * The equivalent java code is:
- * return (int)Math.floor(d);
- * not:
+ * Excel typically converts doubles to integers by truncating toward negative infinity.
+ * The equivalent java code is:
+ * return (int)Math.floor(d);
+ * not:
* return (int)d; // wrong - rounds toward zero
*
*/
@@ -232,21 +232,21 @@ public final class OperandResolver {
}
/**
- * Converts a string to a double using standard rules that Excel would use.
- * Tolerates leading and trailing spaces,
+ * Tolerates leading and trailing spaces,
- * " 123 " -> 123.0
- * ".123" -> 0.123
- * "1E4" -> 1000
- * "-123" -> -123.0
- * These not supported yet:
- * " $ 1,000.00 " -> 1000.0
- * "$1.25E4" -> 12500.0
- * "5**2" -> 500
- * "250%" -> 2.5
+ * Some examples:
+ * " 123 " -> 123.0
+ * ".123" -> 0.123
+ * "1E4" -> 1000
+ * "-123" -> -123.0
+ * These not supported yet:
+ * " $ 1,000.00 " -> 1000.0
+ * "$1.25E4" -> 12500.0
+ * "5**2" -> 500
+ * "250%" -> 2.5
*
* @return null
if the specified text cannot be parsed as a number
*/
diff --git a/src/java/org/apache/poi/ss/formula/eval/PercentEval.java b/src/java/org/apache/poi/ss/formula/eval/PercentEval.java
index 263574a40..d6162e54c 100644
--- a/src/java/org/apache/poi/ss/formula/eval/PercentEval.java
+++ b/src/java/org/apache/poi/ss/formula/eval/PercentEval.java
@@ -22,7 +22,7 @@ import org.apache.poi.ss.formula.functions.Function;
/**
- * Implementation of Excel formula token '%'.
+ * will be used in all subsequent evaluations.
*
* For POI internal use only
*/
diff --git a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java
index 6713ec25e..704aa75ce 100644
--- a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java
+++ b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java
@@ -35,7 +35,7 @@ import org.apache.poi.util.Internal;
/**
* Represents a workbook being used for forked evaluation. Most operations are delegated to the
* shared master workbook, except those that potentially involve cell values that may have been
- * updated after a call to {@link #getOrCreateUpdatableCell(String, int, int)}.
+ * updated after a call to {@link #getOrCreateUpdatableCell(String, int, int)}.
*
* For POI internal use only
*/
diff --git a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java
index c8beb37d1..7cfcaee00 100644
--- a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java
+++ b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java
@@ -89,7 +89,7 @@ public final class ForkedEvaluator {
}
/**
* Copies the values of all updated cells (modified by calls to {@link
- * #updateCell(String, int, int, ValueEval)}) to the supplied workbook.
+ * #updateCell(String, int, int, ValueEval)}) to the supplied workbook.
* Typically, the supplied workbook is a writable copy of the 'master workbook',
* but at the very least it must contain sheets with the same names.
*/
diff --git a/src/java/org/apache/poi/ss/formula/functions/BaseNumberUtils.java b/src/java/org/apache/poi/ss/formula/functions/BaseNumberUtils.java
index 460b87a30..eabfdce49 100644
--- a/src/java/org/apache/poi/ss/formula/functions/BaseNumberUtils.java
+++ b/src/java/org/apache/poi/ss/formula/functions/BaseNumberUtils.java
@@ -17,7 +17,7 @@
package org.apache.poi.ss.formula.functions;
/**
- *
Bin2Dec (number)
- *
+ * Implementation for Excel Bin2Dec() function.
Bin2Dec (number)
+ *
CODE (text )
- *
+ * Implementation for Excel CODE () function.
CODE (text )
+ *
COMPLEX (real_num,i_num,suffix )
- *
+ * Implementation for Excel COMPLEX () function.
COMPLEX (real_num,i_num,suffix )
+ *
*
- *
diff --git a/src/java/org/apache/poi/ss/formula/functions/Dec2Bin.java b/src/java/org/apache/poi/ss/formula/functions/Dec2Bin.java
index 74f115c19..1e0983b86 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Dec2Bin.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Dec2Bin.java
@@ -24,18 +24,18 @@ import org.apache.poi.ss.formula.eval.StringEval;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Implementation for Excel Bin2Dec() function.
- *
- * Syntax:
- * The two dates between which you want to know the number of days.
+ *
+ * The two dates between which you want to know the number of days.
* If start_date occurs after end_date, the DAYS360 function returns a negative number.
+ *
* A logical value that specifies whether to use the U.S. or European method in the calculation
+ *
* the DAYS360 function uses the U.S. (NASD) method. If the starting date is the 31st of a month,
* it becomes equal to the 30th of the same month. If the ending date is the 31st of a month and
* the starting date is earlier than the 30th of a month, the ending date becomes equal to the
* 1st of the next month, otherwise the ending date becomes equal to the 30th of the same month.
- * The month February and leap years are handled in the following way:
+ * The month February and leap years are handled in the following way:
* On a non-leap year the function {@code =DAYS360("2/28/93", "3/1/93", FALSE)} returns 1 day
- * because the DAYS360 function ignores the extra days added to February.
+ * because the DAYS360 function ignores the extra days added to February.
* On a leap year the function {@code =DAYS360("2/29/96","3/1/96", FALSE)} returns 1 day for
* the same reason.
+ *
* When you set the method parameter to TRUE, the DAYS360 function uses the European method.
* Starting dates or ending dates that occur on the 31st of a month become equal to the 30th of
- * the same month. The month February and leap years are handled in the following way:
+ * the same month. The month February and leap years are handled in the following way:
* On a non-leap year the function {@code =DAYS360("2/28/93", "3/1/93", TRUE)} returns
* 3 days because the DAYS360 function is counting the extra days added to February to give
- * February 30 days.
+ * February 30 days.
* On a leap year the function {@code =DAYS360("2/29/96", "3/1/96", TRUE)} returns
* 2 days for the same reason.
Bin2Dec (number,[places] )
- *
+ * Implementation for Excel Bin2Dec() function.
Bin2Dec (number,[places] )
+ *
*
- *
+ *
*
DEC2HEX (number,places )
- *
+ * Implementation for Excel DELTA() function.
DEC2HEX (number,places )
+ *
DELTA (number1,number2 )
- *
+ * Implementation for Excel DELTA() function.
DELTA (number1,number2 )
+ *
- * EOMONTH(start_date,months)
- *
+ * Implementation for the Excel EOMONTH() function.
+ * EOMONTH(start_date,months)
+ * Syntax:
* ERROR.TYPE(errorValue)
*
diff --git a/src/java/org/apache/poi/ss/formula/functions/FactDouble.java b/src/java/org/apache/poi/ss/formula/functions/FactDouble.java
index 42657b7de..c96c4c6e5 100644
--- a/src/java/org/apache/poi/ss/formula/functions/FactDouble.java
+++ b/src/java/org/apache/poi/ss/formula/functions/FactDouble.java
@@ -24,14 +24,14 @@ import java.math.BigInteger;
import java.util.HashMap;
/**
- * Implementation for Excel FACTDOUBLE() function.
- *
- * Syntax:errorValue Return Value
FACTDOUBLE (number)
- *
+ * Implementation for Excel FACTDOUBLE() function.
FACTDOUBLE (number)
+ *
*
+ *
*
*
Implementation Notes:
- * Symbols used in the formulae that follow:
+ * Symbols used in the formulae that follow:
*
*
- * Two important functions with this feature are INDIRECT and OFFSET
+ * argument.
+ * Two important functions with this feature are INDIRECT and OFFSET
HEX2DEC (number)
- *
+ * Implementation for Excel HEX2DEC() function.
HEX2DEC (number)
+ *
+ * HLOOKUP finds a column in a lookup table by the first row value and returns the value from another row.
*
- * Syntax:
- * HLOOKUP(lookup_value, table_array, row_index_num, range_lookup)
+ * HLOOKUP(lookup_value, table_array, row_index_num, range_lookup)
- * table_array An area reference for the lookup data.
- * row_index_num a 1 based index specifying which row value of the lookup data will be returned.
+ * lookup_value The value to be found in the first column of the table array.
+ * table_array An area reference for the lookup data.
+ * row_index_num a 1 based index specifying which row value of the lookup data will be returned.
* range_lookup If TRUE (default), HLOOKUP finds the largest value less than or equal to
- * the lookup_value. If FALSE, only exact matches will be considered
+ * the lookup_value. If FALSE, only exact matches will be considered
*
* @author Josh Micich
*/
diff --git a/src/java/org/apache/poi/ss/formula/functions/Hyperlink.java b/src/java/org/apache/poi/ss/formula/functions/Hyperlink.java
index a43b04014..c69c0b47c 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Hyperlink.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Hyperlink.java
@@ -20,16 +20,16 @@ package org.apache.poi.ss.formula.functions;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Implementation of Excel HYPERLINK function.
- * HYPERLINK(link_location, friendly_name)
+ * HYPERLINK(link_location, friendly_name)
- * friendly_name (optional) the value to display
+ * friendly_name (optional) the value to display
ImReal (Inumber)
- *
+ * Implementation for Excel ImReal() function.
ImReal (Inumber)
+ *
*
IMAGINARY (Inumber)
- *
+ * Implementation for Excel IMAGINARY() function.
IMAGINARY (Inumber)
+ *
*
+ * Syntax :
* INDEX ( reference, row_num[, column_num [, area_num]])
* INDEX ( array, row_num[, column_num])
*
diff --git a/src/java/org/apache/poi/ss/formula/functions/Indirect.java b/src/java/org/apache/poi/ss/formula/functions/Indirect.java
index 1ea3dcd38..ee44b9435 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Indirect.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Indirect.java
@@ -31,15 +31,15 @@ import org.apache.poi.ss.formula.ptg.Area3DPxg;
import org.apache.poi.ss.usermodel.Table;
/**
- * Implementation for Excel function INDIRECT
+ * Implementation for Excel function INDIRECT
+ * normally be written in a cell formula.
* isA1Style (default TRUE) specifies whether the ref_text should be
* interpreted as A1-style or R1C1-style.
*
diff --git a/src/java/org/apache/poi/ss/formula/functions/Intercept.java b/src/java/org/apache/poi/ss/formula/functions/Intercept.java
index f7a142a3b..89542e2da 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Intercept.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Intercept.java
@@ -23,12 +23,12 @@ import org.apache.poi.ss.formula.eval.ValueEval;
import org.apache.poi.ss.formula.functions.LinearRegressionFunction.FUNCTION;
/**
- * Implementation of Excel function INTERCEPT()
+ * Calculates the INTERCEPT of the linear regression line that is used to predict y values from x values
* (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
- * Syntax:
- * INTERCEPT(arrayX, arrayY)
+ * INTERCEPT(arrayX, arrayY)
+ * Calculates the linear regression line that is used to predict y values from x values
* (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
- * Syntax:
- * INTERCEPT(arrayX, arrayY)
+ * INTERCEPT(arrayX, arrayY)
- * ISERR(value)
+ * ISERR(value)
- * ISNA(value)
+ * ISNA(value)
- *
+ * value The value to be tested
+ *
* Returns TRUE if the specified value is '#N/A', FALSE otherwise.
*/
public static final Function ISNA = new LogicalFunction() {
diff --git a/src/java/org/apache/poi/ss/formula/functions/Lookup.java b/src/java/org/apache/poi/ss/formula/functions/Lookup.java
index 81f147bc4..0b20ab36d 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Lookup.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Lookup.java
@@ -24,16 +24,16 @@ import org.apache.poi.ss.formula.functions.LookupUtils.ValueVector;
import org.apache.poi.ss.formula.TwoDEval;
/**
- * Implementation of Excel function LOOKUP.
- * VLOOKUP(lookup_value, lookup_vector, result_vector)
+ * VLOOKUP(lookup_value, lookup_vector, result_vector)
- * lookup_vector> An area reference for the lookup data.
- * result_vector Single row or single column area reference from which the result value is chosen.
+ * lookup_value The value to be found in the lookup vector.
+ * lookup_vector> An area reference for the lookup data.
+ * result_vector Single row or single column area reference from which the result value is chosen.
*
* @author Josh Micich
*/
diff --git a/src/java/org/apache/poi/ss/formula/functions/LookupUtils.java b/src/java/org/apache/poi/ss/formula/functions/LookupUtils.java
index e0bdbedf0..cccb6d64a 100644
--- a/src/java/org/apache/poi/ss/formula/functions/LookupUtils.java
+++ b/src/java/org/apache/poi/ss/formula/functions/LookupUtils.java
@@ -150,11 +150,11 @@ final class LookupUtils {
}
/**
- * Enumeration to support 4 valued comparison results.
* "abc" #REF!
* "" #REF!
- * <blank> #VALUE!
+ *
*
* Note - out of range errors (result index too high) are handled by the caller.
* @return column or row index as a zero-based value, never negative.
diff --git a/src/java/org/apache/poi/ss/formula/functions/Match.java b/src/java/org/apache/poi/ss/formula/functions/Match.java
index 9cf38b2e0..44ff6bbb5 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Match.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Match.java
@@ -31,13 +31,13 @@ import org.apache.poi.ss.formula.functions.LookupUtils.LookupValueComparer;
import org.apache.poi.ss.formula.functions.LookupUtils.ValueVector;
/**
- * Implementation for the MATCH() Excel function.
+ * Implementation for the MATCH() Excel function.
- * MATCH(lookup_value, lookup_array, match_type)
+ * MATCH(lookup_value, lookup_array, match_type)
- * The (ascending) sort order expected by MATCH() is:
- * numbers (low to high), strings (A to Z), boolean (FALSE to TRUE)
+ * The (ascending) sort order expected by MATCH() is:
+ * numbers (low to high), strings (A to Z), boolean (FALSE to TRUE)
* MATCH() ignores all elements in the lookup_array with a different type to the lookup_value.
* Type conversion of the lookup_array elements is never performed.
*/
diff --git a/src/java/org/apache/poi/ss/formula/functions/MathX.java b/src/java/org/apache/poi/ss/formula/functions/MathX.java
index 52b803178..656dd454c 100644
--- a/src/java/org/apache/poi/ss/formula/functions/MathX.java
+++ b/src/java/org/apache/poi/ss/formula/functions/MathX.java
@@ -102,9 +102,9 @@ final class MathX {
/**
* If d < 0, returns short -1
- *
+ *
* If d > 0, returns short 1
- *
+ *
* If d == 0, returns short 0
*
+ *
* n and s are invalid if any of following conditions are true:
*
*
+ *
* n and s are invalid if any of following conditions are true:
*
*
for all n >= 1; factorial n = n * (n-1) * (n-2) * ... * 1
- *
else if n == 0; factorial n = 1
- *
else if n < 0; factorial n = Double.NaN
- *
Loss of precision can occur if n is large enough.
+ *
for all n >= 1; factorial n = n * (n-1) * (n-2) * ... * 1
+ *
else if n == 0; factorial n = 1
+ *
else if n < 0; factorial n = Double.NaN
+ *
Loss of precision can occur if n is large enough.
* If n is large so that the resulting value would be greater
* than Double.MAX_VALUE; Double.POSITIVE_INFINITY is returned.
* If n < 0, Double.NaN is returned.
@@ -288,8 +288,8 @@ final class MathX {
/**
* returns the remainder resulting from operation:
* n / d.
- *
The result has the sign of the divisor.
- *
Examples:
+ *
The result has the sign of the divisor.
+ *
Examples:
*
*
Oct2Dec (number )
+ * Syntax:
Oct2Dec (number )
*
- * OFFSET(reference, rows, cols, height, width)
- * rows is the number of rows up or down from the base reference.
- * cols is the number of columns left or right from the base reference.
- * height (default same height as base reference) is the row count for the returned area reference.
- * width (default same width as base reference) is the column count for the returned area reference.
+ * Syntax:
+ * OFFSET(reference, rows, cols, height, width)
+ * rows is the number of rows up or down from the base reference.
+ * cols is the number of columns left or right from the base reference.
+ * height (default same height as base reference) is the row count for the returned area reference.
+ * width (default same width as base reference) is the column count for the returned area reference.
*
* @author Josh Micich
*/
@@ -71,11 +71,11 @@ public final class Offset implements Function {
return (short) (_offset + _length - 1);
}
/**
- * Moves the range by the specified translation amount.
QUOTIENT(Numerator,Denominator)
*
QUOTIENT(Numerator,Denominator)
- *
+ * you specify, with another text string.
*
- * Syntax:
- * REPLACE(oldText, startNum, numChars, newText)
+ * REPLACE(oldText, startNum, numChars, newText)
- * startNum The position of the first character to replace (1-based)
- * numChars The number of characters to replace
- * newText The new text value to replace the removed section
+ * oldText The text string containing characters to replace
+ * startNum The position of the first character to replace (1-based)
+ * numChars The number of characters to replace
+ * newText The new text value to replace the removed section
*
* @author Manda Wilson < wilson at c bio dot msk cc dot org >
*/
diff --git a/src/java/org/apache/poi/ss/formula/functions/Rept.java b/src/java/org/apache/poi/ss/formula/functions/Rept.java
index 83e43a95f..d448a35b9 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Rept.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Rept.java
@@ -24,10 +24,10 @@ import org.apache.poi.ss.formula.eval.StringEval;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Implementation for Excel REPT () function.
REPT (text,number_times )
- *
+ * Implementation for Excel REPT () function.
REPT (text,number_times )
+ *
WeekNum (Serial_num,Return_type)
- *
+ * Implementation for Excel WeekNum() function.
WeekNum (Serial_num,Return_type)
+ *
+ * Calculates the SLOPE of the linear regression line that is used to predict y values from x values
* (http://introcs.cs.princeton.edu/java/97data/LinearRegression.java.html)
- * Syntax:
- * SLOPE(arrayX, arrayY)
+ * SLOPE(arrayX, arrayY)
+ *
* k <= 0 & k >= v.length and null or empty arrays
* will result in return value Double.NaN
*/
@@ -134,7 +134,7 @@ final class StatsLib {
* returns the kth smallest element in the array. Duplicates
* are considered as distinct values. Hence, eg.
* for array {1,1,2,4,3,3} & k=2, returned value is 1.
- *
+ *
* k <= 0 & k >= v.length or null array or empty array
* will result in return value Double.NaN
* @param v
diff --git a/src/java/org/apache/poi/ss/formula/functions/Substitute.java b/src/java/org/apache/poi/ss/formula/functions/Substitute.java
index 23954b1f0..421e8888b 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Substitute.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Substitute.java
@@ -23,7 +23,7 @@ import org.apache.poi.ss.formula.eval.StringEval;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * An implementation of the SUBSTITUTE function:
- * SUBTOTAL ( functionCode, ref1, ref2 ... )
+ * Syntax :
+ * SUBTOTAL ( functionCode, ref1, ref2 ... )
*
*
* functionCode (1-11) Selects the underlying aggregate function to be used (see table below)
- * ref1, ref2 ... Arguments to be passed to the underlying aggregate function
+ *
*
@@ -57,10 +57,10 @@ import java.util.List;
*
* 10 VAR *
* 11 VARP *
- * 101-111 *
+ *
* * Not implemented in POI yet. Functions 101-111 are the same as functions 1-11 but with
* the option 'ignore hidden values'.
- *
+ *
- * SUMIF ( range, criteria, sum_range )
+ * Syntax :
+ * SUMIF ( range, criteria, sum_range )
*
*
* range The range over which criteria is applied. Also used for addend values when the third parameter is not present
* criteria The value or expression used to filter rows from range
- * sum_range Locates the top-left corner of the corresponding range of addends - values to be added (after being selected by the criteria)
+ *
*
+ * Syntax :
* SUMIFS ( sum_range, criteria_range1, criteria1>,
- * [criteria_range2, criteria2], ...)
+ * [criteria_range2, criteria2], ...)
*
*
+ * Syntax :
* SUMPRODUCT ( array1[, array2[, array3[, ...]]])
*
*
- * array1, ... arrayN typically area references,
* possibly cell references or scalar values
+ *
*
* Let An(i,j) represent the element in the ith row jth column
- * of the nth array
- * Assuming each array has the same dimensions (W, H), the result is defined as:
+ * of the nth array
+ * Assuming each array has the same dimensions (W, H), the result is defined as:
* SUMPRODUCT = Σi: 1..H
* ( Σj: 1..W
* ( Πn: 1..N
@@ -196,7 +196,7 @@ public final class Sumproduct implements Function {
* Determines a double
value for the specified ValueEval
.
* @param isScalarProduct false
for SUMPRODUCTs over area refs.
* @throws EvaluationException if ve
represents an error value.
- *
+ * isScalarProduct
. For scalar products, if any term is blank or a string, the
* error (#VALUE!) is raised. For area (sum)products, if any term is blank or a string, the
diff --git a/src/java/org/apache/poi/ss/formula/functions/Sumx2my2.java b/src/java/org/apache/poi/ss/formula/functions/Sumx2my2.java
index 9c8c38668..28887a5bf 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Sumx2my2.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Sumx2my2.java
@@ -19,11 +19,11 @@ package org.apache.poi.ss.formula.functions;
/**
- * Implementation of Excel function SUMX2MY2()
- * Syntax:
- * SUMX2MY2(arrayX, arrayY)
+ * Syntax:
+ * SUMX2MY2(arrayX, arrayY)
- * Syntax:
- * SUMX2PY2(arrayX, arrayY)
+ * Syntax:
+ * SUMX2PY2(arrayX, arrayY)
- * Syntax:
- * SUMXMY2(arrayX, arrayY)
+ * Syntax:
+ * SUMXMY2(arrayX, arrayY)
+ * An implementation of the MID function
* MID returns a specific number of
- * characters from a text string, starting at the specified position.
MID(text, start_num,
- * num_chars)
+ * Syntax:
MID(text, start_num,
+ * num_chars)
*
* Author: Manda Wilson < wilson at c bio dot msk cc dot org >
*/
@@ -294,14 +294,14 @@ public abstract class TextFunction implements Function {
};
/**
- * An implementation of the TEXT function
+ * An implementation of the TEXT function
* TEXT returns a number value formatted with the given number formatting string.
* This function is not a complete implementation of the Excel function, but
* handles most of the common cases. All work is passed down to
* {@link DataFormatter} to be done, as this works much the same as the
* display focused work that that does.
*
- * Syntax:
TEXT(value, format_text)
+ * Syntax:
TEXT(value, format_text)
*/
public static final Function TEXT = new Fixed2ArgFunction() {
@@ -371,24 +371,24 @@ public abstract class TextFunction implements Function {
}
}
/**
- * Implementation of the FIND() function.
- * FIND(find_text, within_text, start_num)
+ * FIND(find_text, within_text, start_num)
- * SEARCH(find_text, within_text, start_num)
+ * SEARCH(find_text, within_text, start_num)
+ * Implementation of Excel TODAY() Function
*/
public final class Today extends Fixed0ArgFunction {
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex) {
diff --git a/src/java/org/apache/poi/ss/formula/functions/Value.java b/src/java/org/apache/poi/ss/formula/functions/Value.java
index 056ec2f3d..a948ce65e 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Value.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Value.java
@@ -24,9 +24,9 @@ import org.apache.poi.ss.formula.eval.OperandResolver;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
- * Implementation for Excel VALUE() function.
VALUE(text)
+ * Syntax:
VALUE(text)
*
* Converts the text argument to a number. Leading and/or trailing whitespace is
* ignored. Currency symbols and thousands separators are stripped out.
diff --git a/src/java/org/apache/poi/ss/formula/functions/Vlookup.java b/src/java/org/apache/poi/ss/formula/functions/Vlookup.java
index 2f21e21cf..5bdfeba03 100644
--- a/src/java/org/apache/poi/ss/formula/functions/Vlookup.java
+++ b/src/java/org/apache/poi/ss/formula/functions/Vlookup.java
@@ -24,18 +24,18 @@ import org.apache.poi.ss.formula.eval.ValueEval;
import org.apache.poi.ss.formula.functions.LookupUtils.ValueVector;
import org.apache.poi.ss.formula.TwoDEval;
/**
- * Implementation of the VLOOKUP() function.
+ * VLOOKUP finds a row in a lookup table by the first column value and returns the value from another column.
*
- * Syntax:
- * VLOOKUP(lookup_value, table_array, col_index_num, range_lookup)
+ * VLOOKUP(lookup_value, table_array, col_index_num, range_lookup)
- * table_array An area reference for the lookup data.
- * col_index_num a 1 based index specifying which column value of the lookup data will be returned.
+ * lookup_value The value to be found in the first column of the table array.
+ * table_array An area reference for the lookup data.
+ * col_index_num a 1 based index specifying which column value of the lookup data will be returned.
* range_lookup If TRUE (default), VLOOKUP finds the largest value less than or equal to
- * the lookup_value. If FALSE, only exact matches will be considered
+ * the lookup_value. If FALSE, only exact matches will be considered
*/
public final class Vlookup extends Var3or4ArgFunction {
private static final ValueEval DEFAULT_ARG3 = BoolEval.TRUE;
diff --git a/src/java/org/apache/poi/ss/formula/functions/WeekNum.java b/src/java/org/apache/poi/ss/formula/functions/WeekNum.java
index 3941e5bfe..eec44cc86 100644
--- a/src/java/org/apache/poi/ss/formula/functions/WeekNum.java
+++ b/src/java/org/apache/poi/ss/formula/functions/WeekNum.java
@@ -29,13 +29,13 @@ import org.apache.poi.ss.usermodel.DateUtil;
import org.apache.poi.util.LocaleUtil;
/**
- * Implementation for Excel WeekNum() function.
WeekNum (Serial_num,Return_type)
- *
+ * Implementation for Excel WeekNum() function.
WeekNum (Serial_num,Return_type)
+ *
+ *
* The 2 byte encode length field is not written by this method.
* @return number of bytes written
*/
diff --git a/src/java/org/apache/poi/ss/usermodel/BuiltinFormats.java b/src/java/org/apache/poi/ss/usermodel/BuiltinFormats.java
index 4561476b2..57dea1810 100644
--- a/src/java/org/apache/poi/ss/usermodel/BuiltinFormats.java
+++ b/src/java/org/apache/poi/ss/usermodel/BuiltinFormats.java
@@ -18,48 +18,48 @@ package org.apache.poi.ss.usermodel;
/**
* Utility to identify built-in formats. The following is a list of the formats as
- * returned by this class.
- * 1, "0"
- * 2, "0.00"
- * 3, "#,##0"
- * 4, "#,##0.00"
- * 5, "$#,##0_);($#,##0)"
- * 6, "$#,##0_);[Red]($#,##0)"
- * 7, "$#,##0.00);($#,##0.00)"
- * 8, "$#,##0.00_);[Red]($#,##0.00)"
- * 9, "0%"
- * 0xa, "0.00%"
- * 0xb, "0.00E+00"
- * 0xc, "# ?/?"
- * 0xd, "# ??/??"
- * 0xe, "m/d/yy"
- * 0xf, "d-mmm-yy"
- * 0x10, "d-mmm"
- * 0x11, "mmm-yy"
- * 0x12, "h:mm AM/PM"
- * 0x13, "h:mm:ss AM/PM"
- * 0x14, "h:mm"
- * 0x15, "h:mm:ss"
- * 0x16, "m/d/yy h:mm"
- *
+ * returned by this class.
+ * 1, "0"
+ * 2, "0.00"
+ * 3, "#,##0"
+ * 4, "#,##0.00"
+ * 5, "$#,##0_);($#,##0)"
+ * 6, "$#,##0_);[Red]($#,##0)"
+ * 7, "$#,##0.00);($#,##0.00)"
+ * 8, "$#,##0.00_);[Red]($#,##0.00)"
+ * 9, "0%"
+ * 0xa, "0.00%"
+ * 0xb, "0.00E+00"
+ * 0xc, "# ?/?"
+ * 0xd, "# ??/??"
+ * 0xe, "m/d/yy"
+ * 0xf, "d-mmm-yy"
+ * 0x10, "d-mmm"
+ * 0x11, "mmm-yy"
+ * 0x12, "h:mm AM/PM"
+ * 0x13, "h:mm:ss AM/PM"
+ * 0x14, "h:mm"
+ * 0x15, "h:mm:ss"
+ * 0x16, "m/d/yy h:mm"
+ *
- * 0x26, "#,##0_);[Red](#,##0)"
- * 0x27, "#,##0.00_);(#,##0.00)"
- * 0x28, "#,##0.00_);[Red](#,##0.00)"
- * 0x29, "_(* #,##0_);_(* (#,##0);_(* \"-\"_);_(@_)"
- * 0x2a, "_($* #,##0_);_($* (#,##0);_($* \"-\"_);_(@_)"
- * 0x2b, "_(* #,##0.00_);_(* (#,##0.00);_(* \"-\"??_);_(@_)"
- * 0x2c, "_($* #,##0.00_);_($* (#,##0.00);_($* \"-\"??_);_(@_)"
- * 0x2d, "mm:ss"
- * 0x2e, "[h]:mm:ss"
- * 0x2f, "mm:ss.0"
- * 0x30, "##0.0E+0"
- * 0x31, "@" - This is text format.
- * 0x31 "text" - Alias for "@"
- *
+ * 0x26, "#,##0_);[Red](#,##0)"
+ * 0x27, "#,##0.00_);(#,##0.00)"
+ * 0x28, "#,##0.00_);[Red](#,##0.00)"
+ * 0x29, "_(* #,##0_);_(* (#,##0);_(* \"-\"_);_(@_)"
+ * 0x2a, "_($* #,##0_);_($* (#,##0);_($* \"-\"_);_(@_)"
+ * 0x2b, "_(* #,##0.00_);_(* (#,##0.00);_(* \"-\"??_);_(@_)"
+ * 0x2c, "_($* #,##0.00_);_($* (#,##0.00);_($* \"-\"??_);_(@_)"
+ * 0x2d, "mm:ss"
+ * 0x2e, "[h]:mm:ss"
+ * 0x2f, "mm:ss.0"
+ * 0x30, "##0.0E+0"
+ * 0x31, "@" - This is text format.
+ * 0x31 "text" - Alias for "@"
+ *
+ * Get the format index that matches the given format string.
* Automatically converts "text" to excel's format string to represent text.
*
* @param pFmt string matching a built-in format
diff --git a/src/java/org/apache/poi/ss/usermodel/ConditionFilterType.java b/src/java/org/apache/poi/ss/usermodel/ConditionFilterType.java
index 639991558..5f68e689d 100644
--- a/src/java/org/apache/poi/ss/usermodel/ConditionFilterType.java
+++ b/src/java/org/apache/poi/ss/usermodel/ConditionFilterType.java
@@ -23,7 +23,7 @@ package org.apache.poi.ss.usermodel;
* Used primarily for XSSF conditions, which defines a multitude of additional "filter" types
* for conditional formatting. HSSF rules will always be null (not a filter type) or #FILTER.
* XSSF conditions will be null (not a filter type) or any value other than #FILTER.
- * STCfType
for convenience.
*/
public enum ConditionFilterType {
diff --git a/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java b/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
index bb8fec46f..b008dd566 100644
--- a/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
+++ b/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
@@ -92,11 +92,11 @@ public interface ConditionalFormattingRule extends DifferentialStyleProvider {
/**
* This is null if
- * {@link #getConditionType()} != {@link ConditionType#FILTER}
- * {@link #getConditionFilterType()} == null
- * {@link #getConditionType()} != {@link ConditionType#FILTER}
- * {@link #getConditionFilterType()} == null
- * DataFormat
. i.e. "Thursday, January 02, 2003"
* , "01/02/2003" , "02-Jan" , etc.
- * DataFormat
. Supported formats include
* currency, percents, decimals, phone number, SSN, etc.:
* "61.54%", "$100.00", "(800) 555-1234".
- * resize(1.0,1.0)
keeps the original size,
- * resize(0.5,0.5)
resize to 50% of the original,
- * resize(2.0,2.0)
resizes to 200% of the original.
+ * resize(1.0,1.0)
keeps the original size,
+ * resize(0.5,0.5)
resize to 50% of the original,
+ * resize(2.0,2.0)
resizes to 200% of the original.
* resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})
resizes to the dimension of the embedded image.
*
+ * Gets the defined name index by name
* Note: Excel defined names are case-insensitive and
* this method performs a case-insensitive search.
*
diff --git a/src/java/org/apache/poi/ss/util/AreaReference.java b/src/java/org/apache/poi/ss/util/AreaReference.java
index 837c4cf88..fab3619b3 100644
--- a/src/java/org/apache/poi/ss/util/AreaReference.java
+++ b/src/java/org/apache/poi/ss/util/AreaReference.java
@@ -41,7 +41,7 @@ public class AreaReference {
/**
* Create an area ref from a string representation. Sheet names containing special characters should be
- * delimited and escaped as per normal syntax rules for formulas.
+ * delimited and escaped as per normal syntax rules for formulas.
* The area reference must be contiguous (i.e. represent a single rectangle, not a union of rectangles)
*/
public AreaReference(String reference, SpreadsheetVersion version) {
@@ -299,7 +299,7 @@ public class AreaReference {
/**
* Returns a text representation of this area reference.
- *
+ *
*
diff --git a/src/java/org/apache/poi/ss/util/CellRangeAddress.java b/src/java/org/apache/poi/ss/util/CellRangeAddress.java
index 761120ed4..2b65ae660 100644
--- a/src/java/org/apache/poi/ss/util/CellRangeAddress.java
+++ b/src/java/org/apache/poi/ss/util/CellRangeAddress.java
@@ -23,7 +23,7 @@ import org.apache.poi.ss.formula.SheetNameFormatter;
import org.apache.poi.util.LittleEndianOutput;
/**
- * See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'
+ * See OOO documentation: excelfileformat.pdf sec 2.5.14 - 'Cell Range Address'Result Comment
+ * @return code which reflects how the specified range is related to this range.
* Possible return codes are:
*
*
+ * Do all possible cell merges between cells of the list so that:
*
*
*
Version File Format
@@ -474,7 +474,7 @@ public class CellReference {
/**
* Returns a text representation of this cell reference.
- *
+ *
*
diff --git a/src/java/org/apache/poi/ss/util/ExpandedDouble.java b/src/java/org/apache/poi/ss/util/ExpandedDouble.java
index ad9489a73..b647adf21 100644
--- a/src/java/org/apache/poi/ss/util/ExpandedDouble.java
+++ b/src/java/org/apache/poi/ss/util/ExpandedDouble.java
@@ -23,14 +23,14 @@ import static org.apache.poi.ss.util.IEEEDouble.*;
/**
* Represents a 64 bit IEEE double quantity expressed with both decimal and binary exponents
* Does not handle negative numbers or zero
- *
- * The value of a {@link ExpandedDouble} is given byResult Comment
+ *
* a × 2b
- *
- * where:
+ *
+ * where:
*
- * a = significand
- * b = binaryExponent - bitLength(significand) + 1
+ * a = significand
+ * b = binaryExponent - bitLength(significand) + 1
*
* @author Josh Micich
*/
diff --git a/src/java/org/apache/poi/ss/util/MutableFPNumber.java b/src/java/org/apache/poi/ss/util/MutableFPNumber.java
index 50d872f67..1facc8801 100644
--- a/src/java/org/apache/poi/ss/util/MutableFPNumber.java
+++ b/src/java/org/apache/poi/ss/util/MutableFPNumber.java
@@ -24,10 +24,10 @@ final class MutableFPNumber {
// TODO - what about values between (1014-0.5) and (1014-0.05) ?
/**
- * The minimum value in 'Base-10 normalised form'.
+ * The minimum value in 'Base-10 normalised form'.
* When {@link #_binaryExponent} == 46 this is the the minimum {@link #_frac} value
* (1014-0.05) * 2^17
- *
+ *
* Values between (1014-0.05) and 1014 will be represented as '1'
* followed by 14 zeros.
* Values less than (1014-0.05) will get shifted by one more power of 10
@@ -36,7 +36,7 @@ final class MutableFPNumber {
*/
private static final BigInteger BI_MIN_BASE = new BigInteger("0B5E620F47FFFE666", 16);
/**
- * For 'Base-10 normalised form'
+ * For 'Base-10 normalised form'
* The maximum {@link #_frac} value when {@link #_binaryExponent} == 49
* (10^15-0.5) * 2^14
*/
diff --git a/src/java/org/apache/poi/ss/util/NormalisedDecimal.java b/src/java/org/apache/poi/ss/util/NormalisedDecimal.java
index 00a50e143..ca8816b16 100644
--- a/src/java/org/apache/poi/ss/util/NormalisedDecimal.java
+++ b/src/java/org/apache/poi/ss/util/NormalisedDecimal.java
@@ -30,15 +30,15 @@ import java.math.BigInteger;
*
+ *
* significand × 10decimalExponent
- *
- * where:
+ *
+ * where:
*
- * significand = wholePart + fractionalPart / 224
+ * significand = wholePart + fractionalPart / 224
*
* @author Josh Micich
*/
diff --git a/src/java/org/apache/poi/ss/util/NumberComparer.java b/src/java/org/apache/poi/ss/util/NumberComparer.java
index 1d7a8dbe0..56648126e 100644
--- a/src/java/org/apache/poi/ss/util/NumberComparer.java
+++ b/src/java/org/apache/poi/ss/util/NumberComparer.java
@@ -35,23 +35,23 @@ public final class NumberComparer {
* mostly the same as those from {@link Double#compare(double, double)} but with some
* rounding. For numbers that are very close, this code converts to a format having 15
* decimal digits of precision and a decimal exponent, before completing the comparison.
- * false
. In examples like this,
* Excel achieves the effect by having additional logic for comparison operations.
- *
- * "A=B" is "TRUE" but "A-B" is not "0"
- * and
- * "A=B" is "FALSE" but "A-B" is "0"
- *
+ * examples that satisfy
+ * "A=B" is "TRUE" but "A-B" is not "0"
+ * and
+ * "A=B" is "FALSE" but "A-B" is "0"
+ *
* This rule (for rounding the result of a final addition or subtraction), has not been
* implemented in POI (as of Jul-2009).
*
diff --git a/src/java/org/apache/poi/ss/util/NumberToTextConverter.java b/src/java/org/apache/poi/ss/util/NumberToTextConverter.java
index c5b8d936b..6c95c2b81 100644
--- a/src/java/org/apache/poi/ss/util/NumberToTextConverter.java
+++ b/src/java/org/apache/poi/ss/util/NumberToTextConverter.java
@@ -120,7 +120,7 @@ public final class NumberToTextConverter {
/**
* Converts the supplied value to the text representation that Excel would give if
- * the value were to appear in an unformatted cell, or as a literal number in a formula.
+ * the value were to appear in an unformatted cell, or as a literal number in a formula.
* Note - the results from this method differ slightly from those of Double.toString()
* In some special cases Excel behaves quite differently. This function attempts to reproduce
* those results.
diff --git a/src/java/org/apache/poi/ss/util/SheetBuilder.java b/src/java/org/apache/poi/ss/util/SheetBuilder.java
index 366d783ba..ba80711e7 100644
--- a/src/java/org/apache/poi/ss/util/SheetBuilder.java
+++ b/src/java/org/apache/poi/ss/util/SheetBuilder.java
@@ -83,7 +83,7 @@ public class SheetBuilder {
* cells), creates cells if either corresponding array value is not
* null or createEmptyCells property is true.
* The conversion is performed in the following way:
- *
*
java.util.Date
or java.util.Calendar
diff --git a/src/java/org/apache/poi/ss/util/SheetUtil.java b/src/java/org/apache/poi/ss/util/SheetUtil.java
index 6dd27b40f..28e8b4147 100644
--- a/src/java/org/apache/poi/ss/util/SheetUtil.java
+++ b/src/java/org/apache/poi/ss/util/SheetUtil.java
@@ -354,10 +354,10 @@ public class SheetUtil {
/**
* Return the cell, without taking account of merged regions.
- *
+ *
+ * data output stream.
* A typical application is for writing BIFF records when the size is not known until well after
* the header has been written. The client code can call {@link #createDelayedOutput(int)}
* to reserve two bytes of the output for the 'ushort size' header field. The delayed output can
diff --git a/src/java/org/apache/poi/util/LittleEndian.java b/src/java/org/apache/poi/util/LittleEndian.java
index 45fc0eb30..1293e46ee 100644
--- a/src/java/org/apache/poi/util/LittleEndian.java
+++ b/src/java/org/apache/poi/util/LittleEndian.java
@@ -331,7 +331,7 @@ public class LittleEndian implements LittleEndianConsts
/**
* executes:
- *
* data[offset] = (byte)value;
*
diff --git a/src/java/org/apache/poi/util/LittleEndianInputStream.java b/src/java/org/apache/poi/util/LittleEndianInputStream.java
index 428b598d7..886720f3f 100644
--- a/src/java/org/apache/poi/util/LittleEndianInputStream.java
+++ b/src/java/org/apache/poi/util/LittleEndianInputStream.java
@@ -22,7 +22,7 @@ import java.io.IOException;
import java.io.InputStream;
/**
- * Wraps an {@link InputStream} providing {@link LittleEndianInput}
+ * If you want to normalize line endings DOS/MAC (\n\r | \r) to UNIX (\n), you can call the following:
* {@code new ReplacingInputStream(new ReplacingInputStream(is, "\n\r", "\n"), "\r", "\n")}
*
* @param in input
diff --git a/src/java/org/apache/poi/util/StringUtil.java b/src/java/org/apache/poi/util/StringUtil.java
index 15b87ffdf..fa84f6ef5 100644
--- a/src/java/org/apache/poi/util/StringUtil.java
+++ b/src/java/org/apache/poi/util/StringUtil.java
@@ -153,7 +153,7 @@ public class StringUtil {
*
+ *
* This method should be used when the nChars field is not stored
* as a ushort immediately before the is16BitFlag. Otherwise, {@link
* #readUnicodeString(LittleEndianInput)} can be used.
@@ -192,7 +192,7 @@ public class StringUtil {
*
+ *
* This method should be used when the nChars field is not stored
* as a ushort immediately before the is16BitFlag. Otherwise, {@link
* #writeUnicodeString(LittleEndianOutput, String)} can be used.
diff --git a/src/java/org/apache/poi/util/Units.java b/src/java/org/apache/poi/util/Units.java
index e969271da..da0a877cf 100644
--- a/src/java/org/apache/poi/util/Units.java
+++ b/src/java/org/apache/poi/util/Units.java
@@ -50,9 +50,9 @@ public class Units {
* Width of one "standard character" of the default font in pixels. Same for Calibri and Arial.
* "Standard character" defined as the widest digit character in the given font.
* Copied from XSSFWorkbook, since that isn't available here.
- *
+ *
+ *
* Color is optional. When missing, IndexedColors.AUTOMATIC is implied.
* @return the index of the color definition, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#AUTOMATIC}
* @see org.apache.poi.ss.usermodel.IndexedColors
@@ -666,10 +666,10 @@ public class XSSFCellStyle implements CellStyle {
*
+ *
* For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the
* horizon is calculated as:
- *
+ *
* [degrees below horizon] = 90 - textRotation.
*
+ *
* Note: Ensure Foreground color is set prior to background color.
* @param color the color to use
* @see #setFillBackgroundColor(org.apache.poi.xssf.usermodel.XSSFColor) )
@@ -981,7 +981,7 @@ public class XSSFCellStyle implements CellStyle {
/**
* Set the foreground fill color as a indexed color value
- *
+ *
* Note: Ensure Foreground color is set prior to background color.
* @param fg the color to use
* @see org.apache.poi.ss.usermodel.IndexedColors
@@ -1181,10 +1181,10 @@ public class XSSFCellStyle implements CellStyle {
*
+ *
* For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the
* horizon is calculated as:
- *
+ *
* [degrees below horizon] = 90 - textRotation.
* resize(1.0,1.0)
keeps the original size,
- * resize(0.5,0.5)
resize to 50% of the original,
- * resize(2.0,2.0)
resizes to 200% of the original.
+ * resize(1.0,1.0)
keeps the original size,
+ * resize(0.5,0.5)
resize to 50% of the original,
+ * resize(2.0,2.0)
resizes to 200% of the original.
* resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE})
resizes to the dimension of the embedded image.
*
+ *
*
* InputStream is = getPackagePart().getInputStream();
*
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
index 676365e25..b358a93cf 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFSheet.java
@@ -2447,7 +2447,7 @@ public class XSSFSheet extends POIXMLDocumentPart implements Sheet {
* Character width is defined as the maximum digit width
* of the numbers 0, 1, 2, ... 9
as rendered
* using the default font (first font in the workbook).
- *
+ *
* Unless you are using a very special font, the default character is '0' (zero),
* this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF)
*
", "
"));
+ doc = DocumentHelper.readDocument(new ReplacingInputStream(is, "
", "
"));
} catch (SAXException e) {
throw new XmlException(e.getMessage(), e);
}
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
index 97c82791c..7d6529d40 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
@@ -1315,11 +1315,11 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook {
}
/**
- * Removes sheet at the given index.
+ * sheet. (For example when printing - see Bug 40414).
*
* This method makes sure that if the removed sheet was active, another sheet will become
* active in its place. Furthermore, if the removed sheet was the only selected sheet, another
@@ -2013,10 +2013,10 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook {
}
/**
- * Specifies a boolean value that indicates whether structure of workbook is locked.
+ * Specifies a boolean value that indicates whether structure of workbook is locked.
* A value true indicates the structure of the workbook is locked. Worksheets in the workbook can't be moved,
- * deleted, hidden, unhidden, or renamed, and new worksheets can't be inserted.
- * A value of false indicates the structure of the workbook is not locked.
+ * deleted, hidden, unhidden, or renamed, and new worksheets can't be inserted.
+ * A value of false indicates the structure of the workbook is not locked.
*
* @return true if structure of workbook is locked
*/
@@ -2025,9 +2025,9 @@ public class XSSFWorkbook extends POIXMLDocument implements Workbook {
}
/**
- * Specifies a boolean value that indicates whether the windows that comprise the workbook are locked.
+ * Specifies a boolean value that indicates whether the windows that comprise the workbook are locked.
* A value of true indicates the workbook windows are locked. Windows are the same size and position each time the
- * workbook is opened.
+ * workbook is opened.
* A value of false indicates the workbook windows are not locked.
*
* @return true if windows that comprise the workbook are locked
diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellAlignment.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellAlignment.java
index 06e5d0bf6..d10c031c8 100644
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellAlignment.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFCellAlignment.java
@@ -105,13 +105,13 @@ public class XSSFCellAlignment {
/**
* Get the degree of rotation for the text in the cell
- *
+ *
* For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the
* horizon is calculated as:
- *
+ *
* [degrees below horizon] = 90 - textRotation.
*
+ *
* For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the
* horizon is calculated as:
- *
+ *
* [degrees below horizon] = 90 - textRotation.
*
", "
");
+ super(source, "
", "
");
}
}
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/AbstractXWPFSDT.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/AbstractXWPFSDT.java
index cb9bc35dd..204566f8d 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/AbstractXWPFSDT.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/AbstractXWPFSDT.java
@@ -22,9 +22,9 @@ import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTString;
/**
* Experimental abstract class that is a base for XWPFSDT and XWPFSDTCell
- *
- * specifies that the protection is enforced (w:enforcement="1")
- *
+ * Verifies that the documentProtection tag in settings.xml file
+ * specifies that the protection is enforced (w:enforcement="1")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -985,10 +985,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Verifies that the documentProtection tag in settings.xml file
- * specifies that the protection is enforced (w:enforcement="1")
- * and that the kind of protection is readOnly (w:edit="readOnly")
- *
+ * Verifies that the documentProtection tag in settings.xml file
+ * specifies that the protection is enforced (w:enforcement="1")
+ * and that the kind of protection is readOnly (w:edit="readOnly")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -1002,10 +1002,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Verifies that the documentProtection tag in settings.xml file
- * specifies that the protection is enforced (w:enforcement="1")
- * and that the kind of protection is forms (w:edit="forms")
- *
+ * Verifies that the documentProtection tag in settings.xml file
+ * specifies that the protection is enforced (w:enforcement="1")
+ * and that the kind of protection is forms (w:edit="forms")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -1019,10 +1019,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Verifies that the documentProtection tag in settings.xml file
- * specifies that the protection is enforced (w:enforcement="1")
- * and that the kind of protection is comments (w:edit="comments")
- *
+ * Verifies that the documentProtection tag in settings.xml file
+ * specifies that the protection is enforced (w:enforcement="1")
+ * and that the kind of protection is comments (w:edit="comments")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -1036,10 +1036,10 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Verifies that the documentProtection tag in settings.xml file
- * specifies that the protection is enforced (w:enforcement="1")
- * and that the kind of protection is trackedChanges (w:edit="trackedChanges")
- *
+ * Verifies that the documentProtection tag in settings.xml file
+ * specifies that the protection is enforced (w:enforcement="1")
+ * and that the kind of protection is trackedChanges (w:edit="trackedChanges")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -1057,11 +1057,11 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Enforces the readOnly protection.
- * In the documentProtection tag inside settings.xml file,
- * it sets the value of enforcement to "1" (w:enforcement="1")
- * and the value of edit to readOnly (w:edit="readOnly")
- *
+ * Enforces the readOnly protection.
+ * In the documentProtection tag inside settings.xml file,
+ * it sets the value of enforcement to "1" (w:enforcement="1")
+ * and the value of edit to readOnly (w:edit="readOnly")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -1073,8 +1073,8 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Enforces the readOnly protection with a password.
- *
+ * Enforces the readOnly protection with a password.
+ *
* sample snippet from settings.xml
*
* <w:documentProtection w:edit="readOnly" w:enforcement="1"
@@ -1093,11 +1093,11 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Enforce the Filling Forms protection.
- * In the documentProtection tag inside settings.xml file,
- * it sets the value of enforcement to "1" (w:enforcement="1")
- * and the value of edit to forms (w:edit="forms")
- *
+ * Enforce the Filling Forms protection.
+ * In the documentProtection tag inside settings.xml file,
+ * it sets the value of enforcement to "1" (w:enforcement="1")
+ * and the value of edit to forms (w:edit="forms")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -1109,8 +1109,8 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Enforce the Filling Forms protection.
- *
+ * Enforce the Filling Forms protection.
+ *
* sample snippet from settings.xml
*
* <w:documentProtection w:edit="forms" w:enforcement="1"
@@ -1129,11 +1129,11 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Enforce the Comments protection.
- * In the documentProtection tag inside settings.xml file,
- * it sets the value of enforcement to "1" (w:enforcement="1")
- * and the value of edit to comments (w:edit="comments")
- *
+ * Enforce the Comments protection.
+ * In the documentProtection tag inside settings.xml file,
+ * it sets the value of enforcement to "1" (w:enforcement="1")
+ * and the value of edit to comments (w:edit="comments")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -1145,8 +1145,8 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Enforce the Comments protection.
- *
+ * Enforce the Comments protection.
+ *
* sample snippet from settings.xml
*
* <w:documentProtection w:edit="comments" w:enforcement="1"
@@ -1165,11 +1165,11 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Enforce the Tracked Changes protection.
- * In the documentProtection tag inside settings.xml file,
- * it sets the value of enforcement to "1" (w:enforcement="1")
- * and the value of edit to trackedChanges (w:edit="trackedChanges")
- *
+ * Enforce the Tracked Changes protection.
+ * In the documentProtection tag inside settings.xml file,
+ * it sets the value of enforcement to "1" (w:enforcement="1")
+ * and the value of edit to trackedChanges (w:edit="trackedChanges")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -1181,8 +1181,8 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Enforce the Tracked Changes protection.
- *
+ * Enforce the Tracked Changes protection.
+ *
* sample snippet from settings.xml
*
* <w:documentProtection w:edit="trackedChanges" w:enforcement="1"
@@ -1211,9 +1211,9 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
}
/**
- * Remove protection enforcement.
- * In the documentProtection tag inside settings.xml file
- * it sets the value of enforcement to "0" (w:enforcement="0")
+ * Remove protection enforcement.
+ * In the documentProtection tag inside settings.xml file
+ * it sets the value of enforcement to "0" (w:enforcement="0")
*/
public void removeProtectionEnforcement() {
settings.removeEnforcement();
@@ -1221,9 +1221,9 @@ public class XWPFDocument extends POIXMLDocument implements Document, IBody {
/**
* Enforces fields update on document open (in Word).
- * In the settings.xml file
+ * In the settings.xml file
* sets the updateSettings value to true (w:updateSettings w:val="true")
- *
+ *
*
+ *
*
* InputStream is = getPackagePart().getInputStream();
*
diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
index 88a6104cf..85289c502 100644
--- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
+++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFRun.java
@@ -372,8 +372,8 @@ public class XWPFRun implements ISDTContents, IRunElement, CharacterRun {
/**
* Whether the bold property shall be applied to all non-complex script
* characters in the contents of this run when displayed in a document
- *
- * In the zoom tag inside settings.xml file
+ * Set zoom.
+ * In the zoom tag inside settings.xml file
* it sets the value of zoom
- *
+ *
* sample snippet from settings.xml
*
* <w:zoom w:percent="50" />
@@ -95,10 +95,10 @@ public class XWPFSettings extends POIXMLDocumentPart {
}
/**
- * Set zoom.
- * In the zoom tag inside settings.xml file
+ * Set zoom.
+ * In the zoom tag inside settings.xml file
* it sets the value of zoom
- *
+ *
* sample snippet from settings.xml
*
* <w:zoom w:percent="50" />
@@ -113,10 +113,10 @@ public class XWPFSettings extends POIXMLDocumentPart {
}
/**
- * Verifies the documentProtection tag inside settings.xml file
- * if the protection is enforced (w:enforcement="1")
- *
- *
+ * Verifies the documentProtection tag inside settings.xml file
+ * if the protection is enforced (w:enforcement="1")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -136,11 +136,11 @@ public class XWPFSettings extends POIXMLDocumentPart {
}
/**
- * Verifies the documentProtection tag inside settings.xml file
- * if the protection is enforced (w:enforcement="1")
- * and if the kind of protection equals to passed (STDocProtect.Enum editValue)
- *
- *
+ * Verifies the documentProtection tag inside settings.xml file
+ * if the protection is enforced (w:enforcement="1")
+ * and if the kind of protection equals to passed (STDocProtect.Enum editValue)
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -160,12 +160,12 @@ public class XWPFSettings extends POIXMLDocumentPart {
}
/**
- * Enforces the protection with the option specified by passed editValue.
- *
- * In the documentProtection tag inside settings.xml file
- * it sets the value of enforcement to "1" (w:enforcement="1")
- * and the value of edit to the passed editValue (w:edit="[passed editValue]")
- *
+ * Enforces the protection with the option specified by passed editValue.
+ *
+ * In the documentProtection tag inside settings.xml file
+ * it sets the value of enforcement to "1" (w:enforcement="1")
+ * and the value of edit to the passed editValue (w:edit="[passed editValue]")
+ *
* sample snippet from settings.xml
*
* <w:settings ... >
@@ -178,8 +178,8 @@ public class XWPFSettings extends POIXMLDocumentPart {
}
/**
- * Enforces the protection with the option specified by passed editValue and password.
- *
+ * Enforces the protection with the option specified by passed editValue and password.
+ *
* sample snippet from settings.xml
*
* <w:documentProtection w:edit="[passed editValue]" w:enforcement="1"
@@ -343,9 +343,9 @@ public class XWPFSettings extends POIXMLDocumentPart {
}
/**
- * Removes protection enforcement.
- * In the documentProtection tag inside settings.xml file
- * it sets the value of enforcement to "0" (w:enforcement="0")
+ * Removes protection enforcement.
+ * In the documentProtection tag inside settings.xml file
+ * it sets the value of enforcement to "0" (w:enforcement="0")
*/
public void removeEnforcement() {
safeGetDocumentProtection().setEnforcement(STOnOff.X_0);
@@ -353,9 +353,9 @@ public class XWPFSettings extends POIXMLDocumentPart {
/**
* Enforces fields update on document open (in Word).
- * In the settings.xml file
+ * In the settings.xml file
* sets the updateSettings value to true (w:updateSettings w:val="true")
- *
+ *
*
+ * TODO - use simple JDK methods on {@link File} instead:
* {@link File#getParentFile()} instead of {@link FileHelper#getDirectory(File)
* {@link File#getName()} instead of {@link FileHelper#getFilename(File)
*/
diff --git a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFVMLDrawing.java b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFVMLDrawing.java
index b8dbd36a7..477f15919 100644
--- a/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFVMLDrawing.java
+++ b/src/ooxml/testcases/org/apache/poi/xssf/usermodel/TestXSSFVMLDrawing.java
@@ -174,7 +174,7 @@ public class TestXSSFVMLDrawing {
} finally {
stream.close();
}
- Pattern p = Pattern.compile("
");
+ Pattern p = Pattern.compile("
");
int count = 0;
for (XmlObject xo : vml.getItems()) {
String split[] = p.split(xo.toString());
diff --git a/src/ooxml/testcases/org/apache/poi/xssf/util/TestEvilUnclosedBRFixingInputStream.java b/src/ooxml/testcases/org/apache/poi/xssf/util/TestEvilUnclosedBRFixingInputStream.java
index d9010fbbc..654bbb1d4 100644
--- a/src/ooxml/testcases/org/apache/poi/xssf/util/TestEvilUnclosedBRFixingInputStream.java
+++ b/src/ooxml/testcases/org/apache/poi/xssf/util/TestEvilUnclosedBRFixingInputStream.java
@@ -32,7 +32,7 @@ public final class TestEvilUnclosedBRFixingInputStream {
static class EvilUnclosedBRFixingInputStream extends ReplacingInputStream {
public EvilUnclosedBRFixingInputStream(byte[] source) {
- super(new ByteArrayInputStream(source), "
", "
");
+ super(new ByteArrayInputStream(source), "
", "
");
}
}
@@ -49,7 +49,7 @@ public final class TestEvilUnclosedBRFixingInputStream {
@Test
public void testProblem() throws IOException {
byte[] orig = getBytes("
There!
There!
There!
There!
There!
There!
- *
+ * A SlideShowSlideInfo Atom (type 1017).
+ *
*
* An atom record that specifies which transition effects to perform
- * during a slide show, and how to advance to the next presentation slide.
- *
+ * during a slide show, and how to advance to the next presentation slide.
+ *
*
* Combination of effectType and effectDirection:
*
diff --git a/src/scratchpad/src/org/apache/poi/hwmf/record/HwmfBitmapDib.java b/src/scratchpad/src/org/apache/poi/hwmf/record/HwmfBitmapDib.java
index 7c590b6b1..ce4d14879 100644
--- a/src/scratchpad/src/org/apache/poi/hwmf/record/HwmfBitmapDib.java
+++ b/src/scratchpad/src/org/apache/poi/hwmf/record/HwmfBitmapDib.java
@@ -63,7 +63,7 @@ public class HwmfBitmapDib {
BI_BITCOUNT_3(0x0008),
/**
* Each pixel in the bitmap is represented by a 16-bit value.
- *
+ *
* If the Compression field of the BitmapInfoHeader Object is BI_RGB, the Colors field of DIB
* is NULL. Each WORD in the bitmap array represents a single pixel. The relative intensities of
* red, green, and blue are represented with 5 bits for each color component. The value for blue
@@ -71,11 +71,11 @@ public class HwmfBitmapDib {
* bit is not used. The color table is used for optimizing colors on palette-based devices, and
* contains the number of entries specified by the ColorUsed field of the BitmapInfoHeader
* Object.
- *
+ *
* If the Compression field of the BitmapInfoHeader Object is BI_BITFIELDS, the Colors field
* contains three DWORD color masks that specify the red, green, and blue components,
* respectively, of each pixel. Each WORD in the bitmap array represents a single pixel.
- *
+ *
* When the Compression field is set to BI_BITFIELDS, bits set in each DWORD mask MUST be
* contiguous and SHOULD NOT overlap the bits of another mask.
*/
@@ -90,18 +90,18 @@ public class HwmfBitmapDib {
BI_BITCOUNT_5(0x0018),
/**
* The bitmap has a maximum of 2^24 colors.
- *
+ *
* If the Compression field of the BitmapInfoHeader Object is set to BI_RGB, the Colors field
* of DIB is set to NULL. Each DWORD in the bitmap array represents the relative intensities of
* blue, green, and red, respectively, for a pixel. The high byte in each DWORD is not used. The
* Colors color table is used for optimizing colors used on palette-based devices, and MUST
* contain the number of entries specified by the ColorUsed field of the BitmapInfoHeader
* Object.
- *
+ *
* If the Compression field of the BitmapInfoHeader Object is set to BI_BITFIELDS, the Colors
* field contains three DWORD color masks that specify the red, green, and blue components,
* respectively, of each pixel. Each DWORD in the bitmap array represents a single pixel.
- *
+ *
* When the Compression field is set to BI_BITFIELDS, bits set in each DWORD mask must be
* contiguous and should not overlap the bits of another mask. All the bits in the pixel do not
* need to be used.
diff --git a/src/scratchpad/testcases/org/apache/poi/hslf/HSLFTestDataSamples.java b/src/scratchpad/testcases/org/apache/poi/hslf/HSLFTestDataSamples.java
index b70f0d70d..90fb3ad81 100644
--- a/src/scratchpad/testcases/org/apache/poi/hslf/HSLFTestDataSamples.java
+++ b/src/scratchpad/testcases/org/apache/poi/hslf/HSLFTestDataSamples.java
@@ -54,7 +54,7 @@ public class HSLFTestDataSamples {
/**
* Writes a slideshow to a ByteArrayOutputStream and reads it back
- * from a ByteArrayInputStream.
+ * from a ByteArrayInputStream.
+ * Root Test Suite for entire POI project. (Includes all sub-packages of org.apache.poi)
*/
@RunWith(Suite.class)
@Suite.SuiteClasses({
diff --git a/src/testcases/org/apache/poi/hssf/HSSFTestDataSamples.java b/src/testcases/org/apache/poi/hssf/HSSFTestDataSamples.java
index fb64e4e23..2fe3359d4 100644
--- a/src/testcases/org/apache/poi/hssf/HSSFTestDataSamples.java
+++ b/src/testcases/org/apache/poi/hssf/HSSFTestDataSamples.java
@@ -54,7 +54,7 @@ public final class HSSFTestDataSamples {
}
/**
* Writes a spreadsheet to a ByteArrayOutputStream and reads it back
- * from a ByteArrayInputStream.
+ * Test Suite for all sub-packages of org.apache.poi.hssf
*/
@RunWith(Suite.class)
@Suite.SuiteClasses({
diff --git a/src/testcases/org/apache/poi/hssf/model/TestFormulaParser.java b/src/testcases/org/apache/poi/hssf/model/TestFormulaParser.java
index a6cb27343..eb8bedea6 100644
--- a/src/testcases/org/apache/poi/hssf/model/TestFormulaParser.java
+++ b/src/testcases/org/apache/poi/hssf/model/TestFormulaParser.java
@@ -599,7 +599,7 @@ public final class TestFormulaParser {
}
/**
- * Test for bug observable at svn revision 618865 (5-Feb-2008)
+ * Test for bug observable at svn revision 618865 (5-Feb-2008)
* a formula consisting of a single no-arg function got rendered without the function braces
*/
@Test
@@ -920,7 +920,7 @@ public final class TestFormulaParser {
}
/**
* Make sure that POI uses the right Func Ptg when encoding formulas. Functions with variable
- * number of args should get FuncVarPtg, functions with fixed args should get FuncPtg.
+ *
* In addition, leading zeros (on the row component) should be removed from cell
* references during parsing.
*/
diff --git a/src/testcases/org/apache/poi/hssf/model/TestLinkTable.java b/src/testcases/org/apache/poi/hssf/model/TestLinkTable.java
index 4f25a1d08..9d3398007 100644
--- a/src/testcases/org/apache/poi/hssf/model/TestLinkTable.java
+++ b/src/testcases/org/apache/poi/hssf/model/TestLinkTable.java
@@ -50,7 +50,7 @@ public final class TestLinkTable extends TestCase {
/**
* The example file attached to bugzilla 45046 is a clear example of Name records being present
- * without an External Book (SupBook) record. Excel has no trouble reading this file.
+ * without an External Book (SupBook) record. Excel has no trouble reading this file.
* TODO get OOO documentation updated to reflect this (that EXTERNALBOOK is optional).
*
* It's not clear what exact steps need to be taken in Excel to create such a workbook
diff --git a/src/testcases/org/apache/poi/hssf/model/TestSheet.java b/src/testcases/org/apache/poi/hssf/model/TestSheet.java
index 97b3fe0a6..cbd1200ee 100644
--- a/src/testcases/org/apache/poi/hssf/model/TestSheet.java
+++ b/src/testcases/org/apache/poi/hssf/model/TestSheet.java
@@ -474,7 +474,7 @@ public final class TestSheet {
}
/**
* Prior to bug 45066, POI would get the estimated sheet size wrong
- * when an UncalcedRecord was present.
+ * sure that RRA comes before VRA.
*
* The code here represents a normal POI use case where a spreadsheet is created from scratch.
*/
diff --git a/src/testcases/org/apache/poi/hssf/record/TestBoolErrRecord.java b/src/testcases/org/apache/poi/hssf/record/TestBoolErrRecord.java
index 67b151c66..9223dc996 100644
--- a/src/testcases/org/apache/poi/hssf/record/TestBoolErrRecord.java
+++ b/src/testcases/org/apache/poi/hssf/record/TestBoolErrRecord.java
@@ -44,7 +44,7 @@ public final class TestBoolErrRecord extends TestCase {
/**
* Bugzilla 47479 was due to an apparent error in OOO which (as of version 3.0.1)
- * writes the value field of BOOLERR records as 2 bytes instead of 1.
+ * writes the value field of BOOLERR records as 2 bytes instead of 1.
* Coincidentally, the extra byte written is zero, which is exactly the value
* required by the isError field. This probably why Excel seems to have
* no problem. OOO does not have the same bug for error values (which wouldn't
diff --git a/src/testcases/org/apache/poi/hssf/record/TestDConRefRecord.java b/src/testcases/org/apache/poi/hssf/record/TestDConRefRecord.java
index b101a4ee2..98f4d8692 100644
--- a/src/testcases/org/apache/poi/hssf/record/TestDConRefRecord.java
+++ b/src/testcases/org/apache/poi/hssf/record/TestDConRefRecord.java
@@ -210,7 +210,7 @@ public class TestDConRefRecord extends TestCase
/**
* test read-constructor-then-serialize for a double-byte external reference 'UNC-Volume' style
* string
- *
+ * taken from ftPictFmla sub-record in attachment 22860 (stream offset 0x768F).
* Note that the since the string length is zero, there is no unicode flag byte
*/
byte[] data46199 = hr(
diff --git a/src/testcases/org/apache/poi/hssf/record/TestRecordInputStream.java b/src/testcases/org/apache/poi/hssf/record/TestRecordInputStream.java
index 518c5f047..2145b4f4a 100644
--- a/src/testcases/org/apache/poi/hssf/record/TestRecordInputStream.java
+++ b/src/testcases/org/apache/poi/hssf/record/TestRecordInputStream.java
@@ -30,7 +30,7 @@ import junit.framework.TestCase;
public final class TestRecordInputStream extends TestCase {
/**
- * Data inspired by attachment 22626 of bug 45866
+ * Data inspired by attachment 22626 of bug 45866
* A unicode string of 18 chars, with a continue record where the compression flag changes
*/
private static final String HED_DUMP1 = ""
diff --git a/src/testcases/org/apache/poi/hssf/record/TestSubRecord.java b/src/testcases/org/apache/poi/hssf/record/TestSubRecord.java
index b15e05e7a..edf19f81e 100644
--- a/src/testcases/org/apache/poi/hssf/record/TestSubRecord.java
+++ b/src/testcases/org/apache/poi/hssf/record/TestSubRecord.java
@@ -120,7 +120,7 @@ public final class TestSubRecord extends TestCase {
* record 8224 bytes long instead of 70.
* (An aside: It seems more than a coincidence that this problem creates a record of exactly
* {@link RecordInputStream#MAX_RECORD_DATA_SIZE} but not enough is understood about
- * subrecords to explain this.)
+ * subrecords to explain this.)
*
* Excel reads files with this excessive padding OK. It also truncates the over-sized
* ObjRecord back to the proper size. POI should do the same.
diff --git a/src/testcases/org/apache/poi/hssf/record/aggregates/TestFormulaRecordAggregate.java b/src/testcases/org/apache/poi/hssf/record/aggregates/TestFormulaRecordAggregate.java
index cd0815dfa..49d0e8a91 100644
--- a/src/testcases/org/apache/poi/hssf/record/aggregates/TestFormulaRecordAggregate.java
+++ b/src/testcases/org/apache/poi/hssf/record/aggregates/TestFormulaRecordAggregate.java
@@ -51,7 +51,7 @@ public final class TestFormulaRecordAggregate extends TestCase {
/**
* Sometimes a {@link StringRecord} appears after a {@link FormulaRecord} even though the
* formula has evaluated to a text value. This might be more likely to occur when the formula
- * can evaluate to a text value.
+ * can evaluate to a text value.
* Bug 46213 attachment 22874 has such an extra {@link StringRecord} at stream offset 0x5765.
* This file seems to open in Excel (2007) with no trouble. When it is re-saved, Excel omits
* the extra record. POI should do the same.
diff --git a/src/testcases/org/apache/poi/hssf/record/aggregates/TestRowRecordsAggregate.java b/src/testcases/org/apache/poi/hssf/record/aggregates/TestRowRecordsAggregate.java
index 1d8b508c7..3bced93f6 100644
--- a/src/testcases/org/apache/poi/hssf/record/aggregates/TestRowRecordsAggregate.java
+++ b/src/testcases/org/apache/poi/hssf/record/aggregates/TestRowRecordsAggregate.java
@@ -66,7 +66,7 @@ public final class TestRowRecordsAggregate {
* Prior to Aug 2008, POI would re-serialize spreadsheets with {@link ArrayRecord}s or
* {@link TableRecord}s with those records out of order. Similar to
* {@link SharedFormulaRecord}s, these records should appear immediately after the first
- * {@link FormulaRecord}s that they apply to (and only once).
+ * {@link FormulaRecord}s that they apply to (and only once).
*/
@Test
public void testArraysAndTables() throws Exception {
@@ -127,10 +127,10 @@ public final class TestRowRecordsAggregate {
/**
* This problem was noted as the overt symptom of bug 46280. The logic for skipping {@link
* UnknownRecord}s in the constructor {@link RowRecordsAggregate} did not allow for the
- * possibility of tailing {@link ContinueRecord}s.
+ * possibility of tailing {@link ContinueRecord}s.
* The functionality change being tested here is actually not critical to the overall fix
* for bug 46280, since the fix involved making sure the that offending PivotTable
- * records do not get into {@link RowRecordsAggregate}.
+ * records do not get into {@link RowRecordsAggregate}.
* This fix in {@link RowRecordsAggregate} was implemented anyway since any {@link
* UnknownRecord} has the potential of being 'continued'.
*/
diff --git a/src/testcases/org/apache/poi/hssf/record/aggregates/TestSharedValueManager.java b/src/testcases/org/apache/poi/hssf/record/aggregates/TestSharedValueManager.java
index 66f8e89e8..c3c01d8fb 100644
--- a/src/testcases/org/apache/poi/hssf/record/aggregates/TestSharedValueManager.java
+++ b/src/testcases/org/apache/poi/hssf/record/aggregates/TestSharedValueManager.java
@@ -44,7 +44,7 @@ public final class TestSharedValueManager extends TestCase {
* ranges. The first sheet has one row and one column shared formula ranges which intersect.
* The second sheet has two column shared formula ranges - one contained within the other.
* These shared formula ranges were created by fill-dragging a single cell formula across the
- * desired region. The larger shared formula ranges were placed first.
+ * desired region. The larger shared formula ranges were placed first.
*
* There are probably many ways to produce similar effects, but it should be noted that Excel
* is quite temperamental in this regard. Slight variations in technique can cause the shared
@@ -58,7 +58,7 @@ public final class TestSharedValueManager extends TestCase {
* the bugs depended on the {@link SharedFormulaRecord}s being searched in a particular order.
* At the time of writing of the test, the order was being determined by the call to {@link
* Collection#toArray(Object[])} on {@link HashMap#values()} where the items in the map were
- * using default {@link Object#hashCode()}
+ * using default {@link Object#hashCode()}
*/
private static final int MAX_ATTEMPTS=5;
@@ -95,7 +95,7 @@ public final class TestSharedValueManager extends TestCase {
/**
* This bug occurs for similar reasons to the bug in {@link #testPartiallyOverlappingRanges()}
- * but the symptoms are much uglier - serialization fails with {@link NullPointerException}.
+ * but the symptoms are much uglier - serialization fails with {@link NullPointerException}.
*/
public void testCompletelyOverlappedRanges() {
Record[] records;
@@ -128,7 +128,7 @@ public final class TestSharedValueManager extends TestCase {
* records. Prior to this fix, POI would attempt to use the upper left corner of the
* shared formula range as the locator cell. The correct cell to use is the 'first cell'
* in the shared formula group which is not always the top left cell. This is possible
- * because shared formula groups may be sparse and may overlap.
+ * because shared formula groups may be sparse and may overlap.
*
* Two existing sample files (15228.xls and ex45046-21984.xls) had similar issues.
* These were not explored fully, but seem to be fixed now.
diff --git a/src/testcases/org/apache/poi/hssf/record/aggregates/TestValueRecordsAggregate.java b/src/testcases/org/apache/poi/hssf/record/aggregates/TestValueRecordsAggregate.java
index f31c49d44..be9e6a901 100644
--- a/src/testcases/org/apache/poi/hssf/record/aggregates/TestValueRecordsAggregate.java
+++ b/src/testcases/org/apache/poi/hssf/record/aggregates/TestValueRecordsAggregate.java
@@ -214,17 +214,17 @@ public final class TestValueRecordsAggregate {
* Sometimes the 'shared formula' flag (FormulaRecord.isSharedFormula()) is set when
* there is no corresponding SharedFormulaRecord available. SharedFormulaRecord definitions do
* not span multiple sheets. They are are only defined within a sheet, and thus they do not
- * have a sheet index field (only row and column range fields).
+ * have a sheet index field (only row and column range fields).
* So it is important that the code which locates the SharedFormulaRecord for each
* FormulaRecord does not allow matches across sheets.
*
* Prior to bugzilla 44449 (Feb 2008), POI ValueRecordsAggregate.construct(int, List)
* allowed SharedFormulaRecords to be erroneously used across sheets. That incorrect
- * behaviour is shown by this test.
+ * re-saving the file (either with Excel or POI) clears the flag.
*
*
* Prior to the row delete action the spreadsheet has two SharedFormulaRecords. One
- * for each sheet. To expose the bug, the shared formulas have been made to overlap.
+ * for each sheet. To expose the bug, the shared formulas have been made to overlap.
* The row delete action (as described here) seems to to delete the
- * SharedFormulaRecord from Sheet1 (but not clear the 'shared formula' flags.
+ * SharedFormulaRecord from Sheet1 (but not clear the 'shared formula' flags.
* There are other variations on this theme to create the same effect.
*
*/
diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFFormulaEvaluator.java b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFFormulaEvaluator.java
index d8987496f..adabf93f2 100644
--- a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFFormulaEvaluator.java
+++ b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFFormulaEvaluator.java
@@ -94,7 +94,7 @@ public final class TestHSSFFormulaEvaluator extends BaseTestFormulaEvaluator {
/**
* When evaluating defined names, POI has to decide whether it is capable. Currently
- * (May2009) POI only supports simple cell and area refs.
+ * (May2009) POI only supports simple cell and area refs.
* The sample spreadsheet (bugzilla attachment 23508) had a name flagged as 'complex'
* which contained a simple area ref. It is not clear what the 'complex' flag is used
* for but POI should look elsewhere to decide whether it can evaluate the name.
diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFName.java b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFName.java
index cc420feed..725bb8645 100644
--- a/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFName.java
+++ b/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFName.java
@@ -38,7 +38,7 @@ import static org.junit.Assert.*;
public final class TestHSSFName extends BaseTestNamedRange {
/**
- * For manipulating the internals of {@link HSSFName} during testing.
+ * For manipulating the internals of {@link HSSFName} during testing.
* Some tests need a {@link NameRecord} with unusual state, not normally producible by POI.
* This method achieves the aims at low cost without augmenting the POI usermodel api.
* @return a reference to the wrapped {@link NameRecord}
diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestSanityChecker.java b/src/testcases/org/apache/poi/hssf/usermodel/TestSanityChecker.java
index 340187214..c656248dc 100644
--- a/src/testcases/org/apache/poi/hssf/usermodel/TestSanityChecker.java
+++ b/src/testcases/org/apache/poi/hssf/usermodel/TestSanityChecker.java
@@ -33,7 +33,7 @@ import org.apache.poi.hssf.usermodel.SanityChecker.CheckRecord;
import org.junit.Test;
/**
- * A Test case for a test utility class.
+ * A Test case for a test utility class.
* Okay, this may seem strange but I need to test my test logic.
*
* @author Glen Stampoultzis (glens at apache.org)
diff --git a/src/testcases/org/apache/poi/poifs/filesystem/AllPOIFSFileSystemTests.java b/src/testcases/org/apache/poi/poifs/filesystem/AllPOIFSFileSystemTests.java
index e4dfd71ef..871aada67 100644
--- a/src/testcases/org/apache/poi/poifs/filesystem/AllPOIFSFileSystemTests.java
+++ b/src/testcases/org/apache/poi/poifs/filesystem/AllPOIFSFileSystemTests.java
@@ -21,7 +21,7 @@ import org.junit.runner.RunWith;
import org.junit.runners.Suite;
/**
- * Tests for org.apache.poi.poifs.filesystem
+ * Tests for org.apache.poi.poifs.filesystem
*/
@RunWith(Suite.class)
@Suite.SuiteClasses({
diff --git a/src/testcases/org/apache/poi/poifs/property/AllPOIFSPropertyTests.java b/src/testcases/org/apache/poi/poifs/property/AllPOIFSPropertyTests.java
index c4f03a35b..8df7314ee 100644
--- a/src/testcases/org/apache/poi/poifs/property/AllPOIFSPropertyTests.java
+++ b/src/testcases/org/apache/poi/poifs/property/AllPOIFSPropertyTests.java
@@ -21,7 +21,7 @@ import org.junit.runner.RunWith;
import org.junit.runners.Suite;
/**
- * Tests for org.apache.poi.poifs.property
+ * Tests for org.apache.poi.poifs.property
*/
@RunWith(Suite.class)
@Suite.SuiteClasses({
diff --git a/src/testcases/org/apache/poi/poifs/storage/AllPOIFSStorageTests.java b/src/testcases/org/apache/poi/poifs/storage/AllPOIFSStorageTests.java
index 806154599..582b3af78 100644
--- a/src/testcases/org/apache/poi/poifs/storage/AllPOIFSStorageTests.java
+++ b/src/testcases/org/apache/poi/poifs/storage/AllPOIFSStorageTests.java
@@ -20,7 +20,7 @@ package org.apache.poi.poifs.storage;
import org.junit.runner.RunWith;
import org.junit.runners.Suite;
/**
- * Tests for org.apache.poi.poifs.storage
+ * Tests for org.apache.poi.poifs.storage
*/
@RunWith(Suite.class)
@Suite.SuiteClasses({
diff --git a/src/testcases/org/apache/poi/poifs/storage/RawDataUtil.java b/src/testcases/org/apache/poi/poifs/storage/RawDataUtil.java
index f3ae3b087..446ecdeec 100644
--- a/src/testcases/org/apache/poi/poifs/storage/RawDataUtil.java
+++ b/src/testcases/org/apache/poi/poifs/storage/RawDataUtil.java
@@ -29,7 +29,7 @@ import org.apache.poi.util.HexRead;
import org.apache.poi.util.IOUtils;
/**
- * Test utility class.
+ * Test utility class.
*
* Creates raw byte[]
data from hex-dump String arrays.
*
@@ -48,7 +48,7 @@ public final class RawDataUtil {
}
/**
- * Development time utility method.
+ * Development time utility method.
* Transforms a byte array into hex-dump String lines in java source code format.
*/
public static void dumpData(byte[] data) {
@@ -73,7 +73,7 @@ public final class RawDataUtil {
}
/**
- * Development time utility method.
+ * Development time utility method.
* Confirms that the specified byte array is equivalent to the hex-dump String lines.
*/
public static void confirmEqual(byte[] expected, String[] hexDataLines) {
diff --git a/src/testcases/org/apache/poi/ss/format/CellFormatTestBase.java b/src/testcases/org/apache/poi/ss/format/CellFormatTestBase.java
index d28ac8892..1e7ea393a 100644
--- a/src/testcases/org/apache/poi/ss/format/CellFormatTestBase.java
+++ b/src/testcases/org/apache/poi/ss/format/CellFormatTestBase.java
@@ -52,7 +52,7 @@ import org.apache.poi.util.POILogger;
* This class is a base class for spreadsheet-based tests, such as are used for
* cell formatting. This reads tests from the spreadsheet, as well as reading
* flags that can be used to paramterize these tests.
- *
+ *
+ * Tests should extend this class if they need to track the internal working of the {@link WorkbookEvaluator}.
*
* Default method implementations all do nothing
*
diff --git a/src/testcases/org/apache/poi/ss/formula/eval/TestEqualEval.java b/src/testcases/org/apache/poi/ss/formula/eval/TestEqualEval.java
index e10de014c..25690f15f 100644
--- a/src/testcases/org/apache/poi/ss/formula/eval/TestEqualEval.java
+++ b/src/testcases/org/apache/poi/ss/formula/eval/TestEqualEval.java
@@ -33,7 +33,7 @@ public final class TestEqualEval extends TestCase {
private static final EvalInstances EI = null;
/**
- * Test for bug observable at svn revision 692218 (Sep 2008)
+ * Test for bug observable at svn revision 692218 (Sep 2008)
* The value from a 1x1 area should be taken immediately, regardless of srcRow and srcCol
*/
public void test1x1AreaOperand() {
@@ -130,7 +130,7 @@ public final class TestEqualEval extends TestCase {
* Bug 47198 involved a formula "-A1=0" where cell A1 was 0.0.
* Excel evaluates "-A1=0" to TRUE, not because it thinks -0.0==0.0
* but because "-A1" evaluated to +0.0
- *
diff --git a/src/testcases/org/apache/poi/ss/formula/eval/TestUnaryPlusEval.java b/src/testcases/org/apache/poi/ss/formula/eval/TestUnaryPlusEval.java
index c4a39fc14..d060352c1 100644
--- a/src/testcases/org/apache/poi/ss/formula/eval/TestUnaryPlusEval.java
+++ b/src/testcases/org/apache/poi/ss/formula/eval/TestUnaryPlusEval.java
@@ -31,7 +31,7 @@ import org.apache.poi.ss.formula.functions.NumericFunctionInvoker;
public final class TestUnaryPlusEval extends TestCase {
/**
- * Test for bug observable at svn revision 618865 (5-Feb-2008)
+ * Test for bug observable at svn revision 618865 (5-Feb-2008)
* The code for handling column operands had been copy-pasted from the row handling code.
*/
public void testColumnOperand() {
diff --git a/src/testcases/org/apache/poi/ss/formula/eval/forked/TestForkedEvaluator.java b/src/testcases/org/apache/poi/ss/formula/eval/forked/TestForkedEvaluator.java
index e00dbafd3..804fcb20f 100644
--- a/src/testcases/org/apache/poi/ss/formula/eval/forked/TestForkedEvaluator.java
+++ b/src/testcases/org/apache/poi/ss/formula/eval/forked/TestForkedEvaluator.java
@@ -98,7 +98,7 @@ public class TestForkedEvaluator {
* As of Sep 2009, the Forked evaluator can update values from existing cells (this is because
* the underlying 'master' cell is used as a key into the calculation cache. Prior to the fix
* for this bug, an attempt to update a missing cell would result in NPE. This junit tests for
- * a more meaningful error message.
+ * a more meaningful error message.
*
* An alternate solution might involve allowing empty cells to be created as necessary. That
* was considered less desirable because so far, the underlying 'master' workbook is strictly
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/NumericFunctionInvoker.java b/src/testcases/org/apache/poi/ss/formula/functions/NumericFunctionInvoker.java
index f51e8a22f..8dc432eb4 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/NumericFunctionInvoker.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/NumericFunctionInvoker.java
@@ -43,11 +43,11 @@ public final class NumericFunctionInvoker {
/**
* Invokes the specified function with the arguments.
- *
+ * Function.evaluate(args, srcCellRow, srcCellCol)
* are not required.
- *
+ * with minimum overhead.
* Another test: {@link TestIndexFunctionFromSpreadsheet} operates from a higher level
- * and has far greater coverage of input permutations.
+ * and has far greater coverage of input permutations.
*
* @author Josh Micich
*/
@@ -99,7 +99,7 @@ public final class TestIndex extends TestCase {
}
/**
- * Tests expressions like "INDEX(A1:C1,,2)".
+ * Tests expressions like "INDEX(A1:C1,,2)".
* This problem was found while fixing bug 47048 and is observable up to svn r773441.
*/
public void testMissingArg() {
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestIndexFunctionFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestIndexFunctionFromSpreadsheet.java
index 0370b627d..6a543f3ff 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestIndexFunctionFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestIndexFunctionFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests INDEX() as loaded from a test data spreadsheet.
+ * Tests INDEX() as loaded from a test data spreadsheet.
+ * Ensures that the match_type argument can be an AreaEval.
* Bugzilla 44421
*/
public void testMatchArgTypeArea() {
diff --git a/src/testcases/org/apache/poi/ss/formula/functions/TestMatchFunctionsFromSpreadsheet.java b/src/testcases/org/apache/poi/ss/formula/functions/TestMatchFunctionsFromSpreadsheet.java
index df3b52595..cff321610 100644
--- a/src/testcases/org/apache/poi/ss/formula/functions/TestMatchFunctionsFromSpreadsheet.java
+++ b/src/testcases/org/apache/poi/ss/formula/functions/TestMatchFunctionsFromSpreadsheet.java
@@ -22,7 +22,7 @@ import java.util.Collection;
import org.junit.runners.Parameterized.Parameters;
/**
- * Tests Match functions as loaded from a test data spreadsheet.
+ * Common superclass for testing usermodel API for array formulas.
* Formula evaluation is not tested here.
*
* @author Yegor Kozlov
diff --git a/src/testcases/org/apache/poi/ss/util/TestNumberToTextConverter.java b/src/testcases/org/apache/poi/ss/util/TestNumberToTextConverter.java
index f33ece477..e06d355c9 100644
--- a/src/testcases/org/apache/poi/ss/util/TestNumberToTextConverter.java
+++ b/src/testcases/org/apache/poi/ss/util/TestNumberToTextConverter.java
@@ -89,7 +89,7 @@ public final class TestNumberToTextConverter extends TestCase {
* In other places (e.g. {@link NumberRecord}, {@link NumberPtg}, array items (via {@link
* ConstantValueParser}), there seems to be no special NaN translation scheme. If a NaN bit
* pattern is somehow encoded into any of these places Excel actually attempts to render the
- * values as a plain number. That is the unusual functionality that this method is testing.
- * Differences are likely to be observed with other architectures.
+ * Differences are likely to be observed with other architectures.
+ * Test suite for all sub-packages of org.apache.poi.util
*/
@RunWith(Suite.class)
@Suite.SuiteClasses({