You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ye...@apache.org on 2008/11/07 17:59:23 UTC
svn commit: r712196 [1/2] - in /poi/trunk: ./
src/java/org/apache/poi/hssf/dev/ src/java/org/apache/poi/hssf/model/
src/java/org/apache/poi/hssf/record/
src/java/org/apache/poi/hssf/record/aggregates/
src/java/org/apache/poi/hssf/record/cf/ src/java/or...
Author: yegor
Date: Fri Nov 7 08:57:23 2008
New Revision: 712196
URL: http://svn.apache.org/viewvc?rev=712196&view=rev
Log:
javadocs cleanup
Modified:
poi/trunk/build.xml
poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java
poi/trunk/src/java/org/apache/poi/hssf/model/Sheet.java
poi/trunk/src/java/org/apache/poi/hssf/record/CFHeaderRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/CFRuleRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/DBCellRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/DVRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/FileSharingRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/NameRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/RecordInputStream.java
poi/trunk/src/java/org/apache/poi/hssf/record/StyleRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/SupBookRecord.java
poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java
poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java
poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java
poi/trunk/src/java/org/apache/poi/hssf/record/cf/BorderFormatting.java
poi/trunk/src/java/org/apache/poi/hssf/record/cf/CellRangeUtil.java
poi/trunk/src/java/org/apache/poi/hssf/record/cf/FontFormatting.java
poi/trunk/src/java/org/apache/poi/hssf/record/formula/Ptg.java
poi/trunk/src/java/org/apache/poi/hssf/record/formula/eval/OperandResolver.java
poi/trunk/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFConditionalFormatting.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFDataValidation.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFontFormatting.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFPatternFormatting.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationCell.java
poi/trunk/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java
poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java
poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
poi/trunk/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java
poi/trunk/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java
poi/trunk/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java
poi/trunk/src/java/org/apache/poi/ss/util/CellRangeAddressList.java
poi/trunk/src/java/org/apache/poi/ss/util/Region.java
poi/trunk/src/java/org/apache/poi/util/StringUtil.java
poi/trunk/src/ooxml/java/org/apache/poi/util/PackageHelper.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/model/XSSFChildContainingModel.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFont.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFFormulaEvaluator.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPicture.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFPictureData.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFRow.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFWorkbook.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/extensions/XSSFHeaderFooter.java
poi/trunk/src/scratchpad/src/org/apache/poi/hslf/model/ActiveXShape.java
poi/trunk/src/scratchpad/src/org/apache/poi/hslf/model/MovieShape.java
poi/trunk/src/scratchpad/src/org/apache/poi/hslf/model/OLEShape.java
poi/trunk/src/scratchpad/src/org/apache/poi/hslf/record/AnimationInfoAtom.java
poi/trunk/src/scratchpad/src/org/apache/poi/hslf/record/HeadersFootersAtom.java
poi/trunk/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java
poi/trunk/src/scratchpad/src/org/apache/poi/hsmf/datatypes/Chunk.java
poi/trunk/src/scratchpad/src/org/apache/poi/hsmf/parsers/POIFSChunkParser.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/PicturesTable.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/TextPiece.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/model/TextPieceTable.java
poi/trunk/src/scratchpad/src/org/apache/poi/hwpf/usermodel/HeaderStories.java
poi/trunk/src/testcases/org/apache/poi/hssf/usermodel/TestHSSFFormulaEvaluator.java
poi/trunk/src/testcases/org/apache/poi/ss/formula/TestCellCacheEntry.java
poi/trunk/src/testcases/org/apache/poi/ss/formula/TestEvaluationCache.java
Modified: poi/trunk/build.xml
URL: http://svn.apache.org/viewvc/poi/trunk/build.xml?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/build.xml (original)
+++ poi/trunk/build.xml Fri Nov 7 08:57:23 2008
@@ -1010,7 +1010,7 @@
warn-unless-xslt-is-available"
description="Generates the API documentation">
<javadoc verbose="false" author="true" destdir="${apidocs.report.dir}"
- windowtitle="POI API Documentation" use="true" version="true">
+ windowtitle="POI API Documentation" use="true" version="true" maxmemory="256M">
<packageset dir="${main.src}" defaultexcludes="yes">
<include name="org/apache/poi/**"/>
@@ -1022,7 +1022,7 @@
<packageset dir="${contrib.src}" defaultexcludes="yes">
<include name="org/apache/poi/**"/>
</packageset>
- <packageset dir="${examples.src}" defaultexcludes="yes">
+ <packageset dir="${ooxml.src}" defaultexcludes="yes">
<include name="org/apache/poi/**"/>
</packageset>
@@ -1030,7 +1030,7 @@
<path refid="main.classpath"/>
<path refid="scratchpad.classpath"/>
<path refid="contrib.classpath"/>
- <path refid="examples.classpath"/>
+ <path refid="ooxml.classpath"/>
<path path="${env.CLASSPATH}"/>
</classpath>
Modified: poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/dev/BiffViewer.java Fri Nov 7 08:57:23 2008
@@ -52,7 +52,7 @@
/**
* Create an array of records from an input stream
*
- *@param in the InputStream from which the records will be obtained
+ *@param is the InputStream from which the records will be obtained
*@return an array of Records created from the InputStream
*@exception RecordFormatException on error processing the InputStream
*/
Modified: poi/trunk/src/java/org/apache/poi/hssf/model/Sheet.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/model/Sheet.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/model/Sheet.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/model/Sheet.java Fri Nov 7 08:57:23 2008
@@ -148,9 +148,7 @@
* to the passed in records and references to those records held. This function
* is normally called via Workbook.
*
- * @param inRecs array containing those records in the sheet in sequence (normally obtained from RecordFactory)
- * @param sheetnum integer specifying the sheet's number (0,1 or 2 in this release)
- * @param offset of the sheet's BOF record
+ * @param rs the stream to read records from
*
* @return Sheet object with all values set to those read from the file
*
@@ -653,7 +651,6 @@
* at what this sets it to.
*
* @param row the row record to be added
- * @see #setLoc(int)
*/
public void addRow(RowRecord row)
@@ -706,7 +703,6 @@
* subsequent calls will return values in (physical) sequence or NULL when you get to the end.
*
* @return CellValueRecordInterface representing the next value record or NULL if there are no more
- * @see #setLoc(int)
*/
public CellValueRecordInterface[] getValueRecords() {
return _rowsAggregate.getValueRecords();
@@ -723,8 +719,6 @@
* subsequent calls will return rows in (physical) sequence or NULL when you get to the end.
*
* @return RowRecord representing the next row record or NULL if there are no more
- * @see #setLoc(int)
- *
*/
public RowRecord getNextRow() {
if (rowRecIterator == null)
@@ -751,7 +745,6 @@
*
* @param rownum which row to return (careful with LOC)
* @return RowRecord representing the next row record or NULL if there are no more
- * @see #setLoc(int)
*
*/
public RowRecord getRow(int rownum) {
@@ -985,7 +978,7 @@
* @param columnIndex index
* @see org.apache.poi.hssf.record.DefaultColWidthRecord
* @see org.apache.poi.hssf.record.ColumnInfoRecord
- * @see #setColumnWidth(short,short)
+ * @see #setColumnWidth(int, int)
* @return column width in units of 1/256th of a character width
*/
@@ -1036,10 +1029,10 @@
/**
* Get the hidden property for a given column.
- * @param column index
+ * @param columnIndex column index
* @see org.apache.poi.hssf.record.DefaultColWidthRecord
* @see org.apache.poi.hssf.record.ColumnInfoRecord
- * @see #setColumnHidden(short,boolean)
+ * @see #setColumnHidden(int, boolean)
* @return whether the column is hidden or not.
*/
public boolean isColumnHidden(int columnIndex) {
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/CFHeaderRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/CFHeaderRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/CFHeaderRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/CFHeaderRecord.java Fri Nov 7 08:57:23 2008
@@ -87,7 +87,7 @@
/**
* Set cell ranges list to a single cell range and
* modify the enclosing cell range accordingly.
- * @param List cellRanges - list of CellRange objects
+ * @param cellRanges - list of CellRange objects
*/
public void setCellRanges(CellRangeAddress[] cellRanges)
{
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/CFRuleRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/CFRuleRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/CFRuleRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/CFRuleRecord.java Fri Nov 7 08:57:23 2008
@@ -437,7 +437,7 @@
* Subclasses should implement this so that their data is passed back in a
* byte array.
*
- * @param offset to begin writing at
+ * @param pOffset to begin writing at
* @param data byte array containing instance data
* @return number of bytes written
*/
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/ColumnInfoRecord.java Fri Nov 7 08:57:23 2008
@@ -120,7 +120,7 @@
/**
* set whether or not these cells are hidden
* @param ishidden - whether the cells are hidden.
- * @see #setOptions(short)
+ * @see #setOptions(int)
*/
public void setHidden(boolean ishidden)
@@ -130,7 +130,7 @@
/**
* set the outline level for the cells
- * @see #setOptions(short)
+ * @see #setOptions(int)
* @param olevel -outline level for the cells
*/
@@ -142,7 +142,7 @@
/**
* set whether the cells are collapsed
* @param iscollapsed - wether the cells are collapsed
- * @see #setOptions(short)
+ * @see #setOptions(int)
*/
public void setCollapsed(boolean iscollapsed)
@@ -206,7 +206,7 @@
/**
* get whether or not these cells are hidden
* @return whether the cells are hidden.
- * @see #setOptions(short)
+ * @see #setOptions(int)
*/
public boolean getHidden()
@@ -216,7 +216,7 @@
/**
* get the outline level for the cells
- * @see #setOptions(short)
+ * @see #setOptions(int)
* @return outline level for the cells
*/
@@ -228,7 +228,7 @@
/**
* get whether the cells are collapsed
* @return wether the cells are collapsed
- * @see #setOptions(short)
+ * @see #setOptions(int)
*/
public boolean getCollapsed()
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/DBCellRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/DBCellRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/DBCellRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/DBCellRecord.java Fri Nov 7 08:57:23 2008
@@ -148,7 +148,7 @@
}
/**
- * @returns the size of the group of <tt>DBCellRecord</tt>s needed to encode
+ * @return the size of the group of <tt>DBCellRecord</tt>s needed to encode
* the specified number of blocks and rows
*/
public static int calculateSizeOfRecords(int nBlocks, int nRows) {
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/DVRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/DVRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/DVRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/DVRecord.java Fri Nov 7 08:57:23 2008
@@ -66,7 +66,7 @@
/**
* Option flags field
*
- * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
+ * @see HSSFDataValidation utility class
*/
private static final BitField opt_data_type = new BitField(0x0000000F);
private static final BitField opt_error_style = new BitField(0x00000070);
@@ -133,7 +133,7 @@
// --> start option flags
/**
* @return the condition data type
- * @see DVConstraint.ValidationType
+ * @see org.apache.poi.hssf.usermodel.DVConstraint.ValidationType
*/
public int getDataType() {
return opt_data_type.getValue(_option_flags);
@@ -141,7 +141,7 @@
/**
* @return the condition error style
- * @see HSSFDataValidation.ErrorStyle
+ * @see org.apache.poi.hssf.usermodel.HSSFDataValidation.ErrorStyle
*/
public int getErrorStyle() {
return opt_error_style.getValue(_option_flags);
@@ -189,7 +189,7 @@
/**
* get the condition operator
* @return the condition operator
- * @see org.apache.poi.hssf.util.HSSFDataValidation utility class
+ * @see HSSFDataValidation utility class
*/
public int getConditionOperator() {
return opt_condition_operator.getValue(_option_flags);
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/FileSharingRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/FileSharingRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/FileSharingRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/FileSharingRecord.java Fri Nov 7 08:57:23 2008
@@ -90,28 +90,28 @@
}
/**
- * @param hashed password
+ * @param password hashed password
*/
public void setPassword(short password) {
field_2_password = password;
}
/**
- * @returns password hashed with hashPassword() (very lame)
+ * @return password hashed with hashPassword() (very lame)
*/
public short getPassword() {
return field_2_password;
}
/**
- * @returns byte representing the length of the username field
+ * @return byte representing the length of the username field
*/
public short getUsernameLength() {
return (short) field_3_username_value.length();
}
/**
- * @returns username of the user that created the file
+ * @return username of the user that created the file
*/
public String getUsername() {
return field_3_username_value;
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/HyperlinkRecord.java Fri Nov 7 08:57:23 2008
@@ -211,7 +211,7 @@
}
/**
- * Returns a 16-byte guid identifier. Seems to always equal {@link STD_MONIKER}
+ * Returns a 16-byte guid identifier. Seems to always equal {@link #STD_MONIKER}
*
* @return 16-byte guid identifier
*/
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/NameRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/NameRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/NameRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/NameRecord.java Fri Nov 7 08:57:23 2008
@@ -523,7 +523,7 @@
* called by the constructor, should set class level fields. Should throw
* runtime exception for bad/icomplete data.
*
- * @param in the RecordInputstream to read the record from
+ * @param ris the RecordInputstream to read the record from
*/
public NameRecord(RecordInputStream ris) {
LittleEndianInput in = ris;
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/NoteStructureSubRecord.java Fri Nov 7 08:57:23 2008
@@ -40,8 +40,6 @@
/**
* Construct a new <code>NoteStructureSubRecord</code> and
* fill its data with the default values
- * @param size
- * @param in
*/
public NoteStructureSubRecord()
{
@@ -80,10 +78,7 @@
/**
* Serialize the record data into the supplied array of bytes
*
- * @param offset offset in the <code>data</code>
- * @param data the data to serialize into
- *
- * @return size of the record
+ * @param out the stream to serialize into
*/
public void serialize(LittleEndianOutput out) {
out.writeShort(sid);
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/RecordInputStream.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/RecordInputStream.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/RecordInputStream.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/RecordInputStream.java Fri Nov 7 08:57:23 2008
@@ -76,7 +76,7 @@
}
/**
- * @returns the number of bytes available in the current BIFF record
+ * @return the number of bytes available in the current BIFF record
* @see #remaining()
*/
public int available() {
@@ -216,7 +216,6 @@
/**
* Reads a 16 bit, unsigned value.
- * @return
*/
public int readUShort() {
checkRecordPosition(LittleEndian.SHORT_SIZE);
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/StyleRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/StyleRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/StyleRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/StyleRecord.java Fri Nov 7 08:57:23 2008
@@ -94,7 +94,7 @@
/**
* get the actual index of the style extended format record
- * @see #getIndex()
+ * @see #getXFIndex()
* @return index of the xf record
*/
public int getXFIndex() {
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/SupBookRecord.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/SupBookRecord.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/SupBookRecord.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/SupBookRecord.java Fri Nov 7 08:57:23 2008
@@ -80,9 +80,7 @@
* called by the constructor, should set class level fields. Should throw
* runtime exception for bad/incomplete data.
*
- * @param data raw data
- * @param size size of data
- * @param offset of the record's data (provided a big array of the file)
+ * @param in the stream to read from
*/
public SupBookRecord(RecordInputStream in) {
int recLen = in.remaining();
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/CFRecordsAggregate.java Fri Nov 7 08:57:23 2008
@@ -74,8 +74,7 @@
/**
* Create CFRecordsAggregate from a list of CF Records
- * @param recs - list of {@link Record} objects
- * @param offset - position of {@link CFHeaderRecord} object in the list of Record objects
+ * @param rs - the stream to read from
* @return CFRecordsAggregate object
*/
public static CFRecordsAggregate createCFAggregate(RecordStream rs) {
@@ -98,7 +97,6 @@
/**
* Create a deep clone of the record
- * @return
*/
public CFRecordsAggregate cloneCFAggregate()
{
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/RowRecordsAggregate.java Fri Nov 7 08:57:23 2008
@@ -358,7 +358,7 @@
/**
* Create a row record.
*
- * @param row number
+ * @param rowNumber row number
* @return RowRecord created for the passed in row number
* @see org.apache.poi.hssf.record.RowRecord
*/
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java Fri Nov 7 08:57:23 2008
@@ -106,13 +106,6 @@
_groupsBySharedFormulaRecord = m;
}
- /**
- * @param recs list of sheet records (possibly contains records for other parts of the Excel file)
- * @param startIx index of first row/cell record for current sheet
- * @param endIx one past index of last row/cell record for current sheet. It is important
- * that this code does not inadvertently collect <tt>SharedFormulaRecord</tt>s from any other
- * sheet (which could happen if endIx is chosen poorly). (see bug 44449)
- */
public static SharedValueManager create(SharedFormulaRecord[] sharedFormulaRecords,
ArrayRecord[] arrayRecords, TableRecord[] tableRecords) {
if (sharedFormulaRecords.length + arrayRecords.length + tableRecords.length < 1) {
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/cf/BorderFormatting.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/cf/BorderFormatting.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/cf/BorderFormatting.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/cf/BorderFormatting.java Fri Nov 7 08:57:23 2008
@@ -321,7 +321,7 @@
/**
* get the color to use for the left border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
- * @param color The index of the color definition
+ * @return The index of the color definition
*/
public int getLeftBorderColor() {
return bordLeftLineColor.getValue(field_13_border_styles1);
@@ -338,7 +338,7 @@
/**
* get the color to use for the right border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
- * @param color The index of the color definition
+ * @return The index of the color definition
*/
public int getRightBorderColor() {
return bordRightLineColor.getValue(field_13_border_styles1);
@@ -355,7 +355,7 @@
/**
* get the color to use for the top border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
- * @param color The index of the color definition
+ * @return The index of the color definition
*/
public int getTopBorderColor() {
return bordTopLineColor.getValue(field_14_border_styles2);
@@ -373,7 +373,7 @@
/**
* get the color to use for the bottom border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
- * @param color The index of the color definition
+ * @return The index of the color definition
*/
public int getBottomBorderColor() {
return bordBottomLineColor.getValue(field_14_border_styles2);
@@ -390,7 +390,7 @@
/**
* get the color to use for the diagonal border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
- * @param color The index of the color definition
+ * @return The index of the color definition
*/
public int getDiagonalBorderColor() {
return bordDiagLineColor.getValue(field_14_border_styles2);
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/cf/CellRangeUtil.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/cf/CellRangeUtil.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/cf/CellRangeUtil.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/cf/CellRangeUtil.java Fri Nov 7 08:57:23 2008
@@ -89,7 +89,7 @@
* Do all possible cell merges between cells of the list so that:<br>
* <li>if a cell range is completely inside of another cell range, it gets removed from the list
* <li>if two cells have a shared border, merge them into one bigger cell range
- * @param cellRangeList
+ * @param cellRanges
* @return updated List of cell ranges
*/
public static CellRangeAddress[] mergeCellRanges(CellRangeAddress[] cellRanges) {
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/cf/FontFormatting.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/cf/FontFormatting.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/cf/FontFormatting.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/cf/FontFormatting.java Fri Nov 7 08:57:23 2008
@@ -188,8 +188,8 @@
/**
* set the font to be italics or not
*
- * @param italics - whether the font is italics or not
- * @see #setAttributes(short)
+ * @param italic - whether the font is italics or not
+ * @see #setFontOption(boolean, org.apache.poi.util.BitField)
*/
public void setItalic(boolean italic)
@@ -201,7 +201,7 @@
* get whether the font is to be italics or not
*
* @return italics - whether the font is italics or not
- * @see #getAttributes()
+ * @see #getFontOption(org.apache.poi.util.BitField)
*/
public boolean isItalic()
@@ -244,7 +244,7 @@
* get whether the font is to be stricken out or not
*
* @return strike - whether the font is stricken out or not
- * @see #getAttributes()
+ * @see #getFontOption(org.apache.poi.util.BitField)
*/
public boolean isStruckout()
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/formula/Ptg.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/formula/Ptg.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/formula/Ptg.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/formula/Ptg.java Fri Nov 7 08:57:23 2008
@@ -260,7 +260,7 @@
public abstract int getSize();
/**
- * @return the encoded length of this Ptg, not including the initial Ptg type identifier byte.
+ * //@return the encoded length of this Ptg, not including the initial Ptg type identifier byte.
*/
// public abstract int getDataSize();
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/formula/eval/OperandResolver.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/formula/eval/OperandResolver.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/formula/eval/OperandResolver.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/formula/eval/OperandResolver.java Fri Nov 7 08:57:23 2008
@@ -234,7 +234,7 @@
* "5**2" -> 500<br/>
* "250%" -> 2.5<br/>
*
- * @param text
+ * @param pText
* @return <code>null</code> if the specified text cannot be parsed as a number
*/
public static Double parseDouble(String pText) {
Modified: poi/trunk/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java Fri Nov 7 08:57:23 2008
@@ -90,7 +90,7 @@
* An implementation of the TRIM function:
* Removes leading and trailing spaces from value if evaluated operand
* value is string.
- * @author Manda Wilson < wilson at c bio dot msk cc dot org >
+ * Author: Manda Wilson < wilson at c bio dot msk cc dot org >
*/
public static final Function TRIM = new SingleArgTextFunc() {
protected ValueEval evaluate(String arg) {
@@ -106,7 +106,7 @@
* <b>Syntax<b>:<br/> <b>MID</b>(<b>text</b>, <b>start_num</b>,
* <b>num_chars</b>)<br/>
*
- * @author Manda Wilson < wilson at c bio dot msk cc dot org >
+ * Author: Manda Wilson < wilson at c bio dot msk cc dot org >
*/
public static final Function MID = new TextFunction() {
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFCell.java Fri Nov 7 08:57:23 2008
@@ -216,7 +216,6 @@
/**
* Returns the Workbook that this Cell is bound to
- * @return
*/
protected Workbook getBoundWorkbook() {
return book.getWorkbook();
@@ -1085,7 +1084,7 @@
/**
* Assign a hypelrink to this cell
*
- * @param link hypelrink associated with this cell
+ * @param hyperlink hypelrink associated with this cell
*/
public void setHyperlink(Hyperlink hyperlink){
HSSFHyperlink link = (HSSFHyperlink)hyperlink;
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java Fri Nov 7 08:57:23 2008
@@ -438,28 +438,6 @@
}
/**
- * get whether this cell is to be part of a merged block of cells
- *
- * @returns merged or not
- */
-
-// public boolean getMergeCells()
-// {
-// return format.getMergeCells();
-// }
-
- /**
- * set whether this cell is to be part of a merged block of cells
- *
- * @param merge merged or not
- */
-
-// public void setMergeCells(boolean merge)
-// {
-// format.setMergeCells(merge);
-// }
-
- /**
* set whether the text should be wrapped
* @param wrapped wrap text or not
*/
@@ -767,7 +745,7 @@
/**
* get the color to use for the left border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
- * @param color The index of the color definition
+ * @return The index of the color definition
*/
public short getLeftBorderColor()
{
@@ -786,7 +764,7 @@
/**
* get the color to use for the left border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
- * @param color The index of the color definition
+ * @return The index of the color definition
*/
public short getRightBorderColor()
{
@@ -805,7 +783,7 @@
/**
* get the color to use for the top border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
- * @param color The index of the color definition
+ * @return The index of the color definition
*/
public short getTopBorderColor()
{
@@ -824,7 +802,7 @@
/**
* get the color to use for the left border
* @see org.apache.poi.hssf.usermodel.HSSFPalette#getColor(short)
- * @param color The index of the color definition
+ * @return The index of the color definition
*/
public short getBottomBorderColor()
{
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFConditionalFormatting.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFConditionalFormatting.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFConditionalFormatting.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFConditionalFormatting.java Fri Nov 7 08:57:23 2008
@@ -43,7 +43,7 @@
* </LI>
* </UL>
*
- * Use {@link HSSFSheet#getConditionalFormattingAt(int)} to get access to an instance of this class.
+ * Use {@link org.apache.poi.hssf.usermodel.HSSFSheet#getSheetConditionalFormatting()} to get access to an instance of this class.
* <P>
* To create a new Conditional Formatting set use the following approach:
*
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFDataValidation.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFDataValidation.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFDataValidation.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFDataValidation.java Fri Nov 7 08:57:23 2008
@@ -138,7 +138,7 @@
}
/**
- * @param show <code>true</code> if an prompt box should be displayed , <code>false</code> otherwise
+ * @return <code>true</code> if an prompt box should be displayed , <code>false</code> otherwise
*/
public boolean getShowPromptBox() {
return _showPromptBox;
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFontFormatting.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFontFormatting.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFontFormatting.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFontFormatting.java Fri Nov 7 08:57:23 2008
@@ -102,7 +102,6 @@
}
/**
- * @return
* @see org.apache.poi.hssf.record.cf.FontFormatting#getRawRecord()
*/
protected byte[] getRawRecord()
@@ -228,7 +227,7 @@
* set font style options.
*
* @param italic - if true, set posture style to italic, otherwise to normal
- * @param bold- if true, set font weight to bold, otherwise to normal
+ * @param bold if true, set font weight to bold, otherwise to normal
*/
public void setFontStyle(boolean italic, boolean bold)
@@ -302,7 +301,7 @@
/**
* @param height
- * @see org.apache.poi.hssf.record.cf.FontFormatting#setFontHeight(short)
+ * @see org.apache.poi.hssf.record.cf.FontFormatting#setFontHeight(int)
*/
public void setFontHeight(int height)
{
@@ -369,7 +368,7 @@
/**
* set the type of underlining type for the font
*
- * @param u super or subscript option
+ * @param underlineType super or subscript option
*
* @see #U_NONE
* @see #U_SINGLE
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFFormulaEvaluator.java Fri Nov 7 08:57:23 2008
@@ -33,7 +33,7 @@
* Evaluates formula cells.<p/>
*
* For performance reasons, this class keeps a cache of all previously calculated intermediate
- * cell values. Be sure to call {@link #clearCache()} if any workbook cells are changed between
+ * cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between
* calls to evaluate~ methods on this class.
*
* @author Amol S. Deshmukh < amolweb at ya hoo dot com >
@@ -156,7 +156,7 @@
* int evaluatedCellType = evaluator.evaluateFormulaCell(cell);
* </pre>
* Be aware that your cell will hold both the formula, and the result. If you want the cell
- * replaced with the result of the formula, use {@link #evaluateInCell(HSSFCell)}
+ * replaced with the result of the formula, use {@link #evaluateInCell(org.apache.poi.ss.usermodel.Cell)}
* @param cell The cell to evaluate
* @return -1 for non-formula cells, or the type of the <em>formula result</em>
*/
@@ -183,7 +183,7 @@
* </pre>
* Be aware that your cell value will be changed to hold the
* result of the formula. If you simply want the formula
- * value computed for you, use {@link #evaluateFormulaCell(HSSFCell)}
+ * value computed for you, use {@link #evaluateFormulaCell(org.apache.poi.ss.usermodel.Cell)}}
* @param cell
*/
public HSSFCell evaluateInCell(Cell cell) {
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFPatternFormatting.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFPatternFormatting.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFPatternFormatting.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFPatternFormatting.java Fri Nov 7 08:57:23 2008
@@ -82,7 +82,6 @@
}
/**
- * @return
* @see org.apache.poi.hssf.record.cf.PatternFormatting#getFillBackgroundColor()
*/
public short getFillBackgroundColor()
@@ -91,7 +90,6 @@
}
/**
- * @return
* @see org.apache.poi.hssf.record.cf.PatternFormatting#getFillForegroundColor()
*/
public short getFillForegroundColor()
@@ -100,7 +98,6 @@
}
/**
- * @return
* @see org.apache.poi.hssf.record.cf.PatternFormatting#getFillPattern()
*/
public short getFillPattern()
@@ -110,7 +107,7 @@
/**
* @param bg
- * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillBackgroundColor(short)
+ * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillBackgroundColor(int)
*/
public void setFillBackgroundColor(short bg)
{
@@ -123,7 +120,7 @@
/**
* @param fg
- * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillForegroundColor(short)
+ * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillForegroundColor(int)
*/
public void setFillForegroundColor(short fg)
{
@@ -136,7 +133,7 @@
/**
* @param fp
- * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillPattern(short)
+ * @see org.apache.poi.hssf.record.cf.PatternFormatting#setFillPattern(int)
*/
public void setFillPattern(short fp)
{
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java Fri Nov 7 08:57:23 2008
@@ -317,7 +317,7 @@
* Get the hssfcell representing a given column (logical cell)
* 0-based. If you ask for a cell that is not defined then
* you get a null, unless you have set a different
- * {@link MissingCellPolicy} on the base workbook.
+ * {@link org.apache.poi.ss.usermodel.Row.MissingCellPolicy} on the base workbook.
*
* @param cellnum 0 based column number
* @return HSSFCell representing that column or null if undefined.
@@ -560,7 +560,7 @@
* will not return un-defined (null) cells.
* Call getCellNum() on the returned cells to know which cell they are.
* As this only ever works on physically defined cells,
- * the {@link MissingCellPolicy} has no effect.
+ * the {@link org.apache.poi.ss.usermodel.Row.MissingCellPolicy} has no effect.
*/
public Iterator cellIterator()
{
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java Fri Nov 7 08:57:23 2008
@@ -201,7 +201,7 @@
* @param rownum row number
* @return High level HSSFRow object representing a row in the sheet
* @see org.apache.poi.hssf.usermodel.HSSFRow
- * @see #removeRow(HSSFRow)
+ * @see #removeRow(org.apache.poi.ss.usermodel.Row)
*/
public HSSFRow createRow(int rownum)
{
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFSheetConditionalFormatting.java Fri Nov 7 08:57:23 2008
@@ -45,7 +45,7 @@
* TODO - formulas containing cell references are currently not parsed properly
*
* @param comparisonOperation - a constant value from
- * <tt>{@link HSSFConditionalFormattingRule.ComparisonOperator}</tt>: <p>
+ * <tt>{@link org.apache.poi.hssf.record.CFRuleRecord.ComparisonOperator}</tt>: <p>
* <ul>
* <li>BETWEEN</li>
* <li>NOT_BETWEEN</li>
@@ -59,8 +59,8 @@
* </p>
* @param formula1 - formula for the valued, compared with the cell
* @param formula2 - second formula (only used with
- * {@link HSSFConditionalFormattingRule#COMPARISON_OPERATOR_BETWEEN}) and
- * {@link HSSFConditionalFormattingRule#COMPARISON_OPERATOR_NOT_BETWEEN} operations)
+ * {@link org.apache.poi.hssf.record.CFRuleRecord.ComparisonOperator#BETWEEN}) and
+ * {@link org.apache.poi.hssf.record.CFRuleRecord.ComparisonOperator#NOT_BETWEEN} operations)
*/
public HSSFConditionalFormattingRule createConditionalFormattingRule(
byte comparisonOperation,
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java Fri Nov 7 08:57:23 2008
@@ -382,7 +382,7 @@
* Sets the policy on what to do when
* getting missing or blank cells from a row.
* This will then apply to all calls to
- * {@link HSSFRow.getCell()}. See
+ * {@link HSSFRow#getCell(int)}}. See
* {@link MissingCellPolicy}.
* Note that this has no effect on any
* iterators, only on when fetching Cells
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationCell.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationCell.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationCell.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationCell.java Fri Nov 7 08:57:23 2008
@@ -21,7 +21,7 @@
* Abstracts a cell for the purpose of formula evaluation. This interface represents both formula
* and non-formula cells.<br/>
*
- * Implementors of this class must implement {@link #hashCode()} and {@link #equals(Object)}
+ * Implementors of this class must implement {@link Object#hashCode()} and {@link Object#equals(Object)}
* to provide an <em>identity</em> relationship based on the underlying HSSF or XSSF cell <p/>
*
* For POI internal use only
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/ExternSheetReferenceToken.java Fri Nov 7 08:57:23 2008
@@ -18,7 +18,7 @@
package org.apache.poi.ss.formula;
/**
- * Should be implemented by any {@link Ptg} subclass that needs has an extern sheet index <br/>
+ * Should be implemented by any {@link org.apache.poi.hssf.record.formula.Ptg} subclass that needs has an extern sheet index <br/>
*
* For POI internal use only
*
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookDependentFormula.java Fri Nov 7 08:57:23 2008
@@ -18,7 +18,7 @@
package org.apache.poi.ss.formula;
/**
- * Should be implemented by any {@link Ptg} subclass that needs a workbook to render its formula.
+ * Should be implemented by any {@link org.apache.poi.hssf.record.formula.Ptg} subclass that needs a workbook to render its formula.
* <br/>
*
* For POI internal use only
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java Fri Nov 7 08:57:23 2008
@@ -68,7 +68,7 @@
* Evaluates formula cells.<p/>
*
* For performance reasons, this class keeps a cache of all previously calculated intermediate
- * cell values. Be sure to call {@link #clearCache()} if any workbook cells are changed between
+ * cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between
* calls to evaluate~ methods on this class.<br/>
*
* For POI internal use only
Modified: poi/trunk/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/usermodel/FormulaEvaluator.java Fri Nov 7 08:57:23 2008
@@ -17,20 +17,11 @@
package org.apache.poi.ss.usermodel;
-import org.apache.poi.hssf.record.formula.eval.BlankEval;
-import org.apache.poi.hssf.record.formula.eval.BoolEval;
-import org.apache.poi.hssf.record.formula.eval.ErrorEval;
-import org.apache.poi.hssf.record.formula.eval.NumberEval;
-import org.apache.poi.hssf.record.formula.eval.StringEval;
-import org.apache.poi.hssf.record.formula.eval.ValueEval;
-import org.apache.poi.hssf.usermodel.HSSFSheet;
-
-
/**
* Evaluates formula cells.<p/>
*
* For performance reasons, this class keeps a cache of all previously calculated intermediate
- * cell values. Be sure to call {@link #clearCache()} if any workbook cells are changed between
+ * cell values. Be sure to call {@link #clearAllCachedResultValues()} if any workbook cells are changed between
* calls to evaluate~ methods on this class.
*
* @author Amol S. Deshmukh < amolweb at ya hoo dot com >
Modified: poi/trunk/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/usermodel/HeaderFooter.java Fri Nov 7 08:57:23 2008
@@ -17,8 +17,8 @@
package org.apache.poi.ss.usermodel;
/**
- * Common interface for {@link Header} and
- * {@link Footer}.
+ * Common interface for {@link org.apache.poi.ss.usermodel.Header} and
+ * {@link org.apache.poi.ss.usermodel.Footer}.
*/
public interface HeaderFooter {
/**
Modified: poi/trunk/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/util/CellRangeAddressBase.java Fri Nov 7 08:57:23 2008
@@ -101,28 +101,28 @@
}
/**
- * @param _firstCol column number for the upper left hand corner
+ * @param firstCol column number for the upper left hand corner
*/
public final void setFirstColumn(int firstCol) {
_firstCol = firstCol;
}
/**
- * @param rowFrom row number for the upper left hand corner
+ * @param firstRow row number for the upper left hand corner
*/
public final void setFirstRow(int firstRow) {
_firstRow = firstRow;
}
/**
- * @param colTo column number for the lower right hand corner
+ * @param lastCol column number for the lower right hand corner
*/
public final void setLastColumn(int lastCol) {
_lastCol = lastCol;
}
/**
- * @param rowTo row number for the lower right hand corner
+ * @param lastRow row number for the lower right hand corner
*/
public final void setLastRow(int lastRow) {
_lastRow = lastRow;
Modified: poi/trunk/src/java/org/apache/poi/ss/util/CellRangeAddressList.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/util/CellRangeAddressList.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/util/CellRangeAddressList.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/util/CellRangeAddressList.java Fri Nov 7 08:57:23 2008
@@ -84,7 +84,6 @@
* @param firstCol - the upper left hand corner's col
* @param lastRow - the lower right hand corner's row
* @param lastCol - the lower right hand corner's col
- * @return the index of this ADDR structure
*/
public void addCellRangeAddress(int firstRow, int firstCol, int lastRow, int lastCol) {
CellRangeAddress region = new CellRangeAddress(firstRow, lastRow, firstCol, lastCol);
Modified: poi/trunk/src/java/org/apache/poi/ss/util/Region.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/util/Region.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/util/Region.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/util/Region.java Fri Nov 7 08:57:23 2008
@@ -209,7 +209,7 @@
/**
* Convert a List of CellRange objects to an array of regions
*
- * @param List of CellRange objects
+ * @param cellRanges list of CellRange objects
* @return regions
*/
public static Region[] convertCellRangesToRegions(CellRangeAddress[] cellRanges) {
Modified: poi/trunk/src/java/org/apache/poi/util/StringUtil.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/util/StringUtil.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/util/StringUtil.java (original)
+++ poi/trunk/src/java/org/apache/poi/util/StringUtil.java Fri Nov 7 08:57:23 2008
@@ -25,7 +25,7 @@
/**
* Title: String Utility Description: Collection of string handling utilities<p/>
*
- * Note - none of the methods in this class deals with {@link ContinueRecord}s. For such
+ * Note - none of the methods in this class deals with {@link org.apache.poi.hssf.record.ContinueRecord}s. For such
* functionality, consider using {@link RecordInputStream
} *
*
Modified: poi/trunk/src/ooxml/java/org/apache/poi/util/PackageHelper.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/util/PackageHelper.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/util/PackageHelper.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/util/PackageHelper.java Fri Nov 7 08:57:23 2008
@@ -84,9 +84,7 @@
}
/**
- *
- * @return
- * @throws IOException
+ * Creates an empty file in the default temporary-file directory,
*/
public static File createTempFile() throws IOException {
File file = File.createTempFile("poi-ooxml-", ".tmp");
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/model/XSSFChildContainingModel.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/model/XSSFChildContainingModel.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/model/XSSFChildContainingModel.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/model/XSSFChildContainingModel.java Fri Nov 7 08:57:23 2008
@@ -36,7 +36,7 @@
* appropriate model or usermodel thing can be
* created for it.
* @param childPart The PackagePart of the child
- * @param childId the ID of the relationship the child comes from
+ * @param childRelId the ID of the relationship the child comes from
*/
public void generateChild(PackagePart childPart, String childRelId);
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCell.java Fri Nov 7 08:57:23 2008
@@ -86,8 +86,8 @@
/**
* Construct a XSSFCell.
*
- * @param row the xml bean containing information about the cell.
* @param row the parent row.
+ * @param cell the xml bean containing information about the cell.
*/
protected XSSFCell(XSSFRow row, CTCell cell) {
this.cell = cell;
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java?rev=712196&r1=712195&r2=712196&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCellStyle.java Fri Nov 7 08:57:23 2008
@@ -120,13 +120,13 @@
* Get the type of horizontal alignment for the cell
*
* @return short - the type of alignment
- * @see #ALIGN_GENERAL
- * @see #ALIGN_LEFT
- * @see #ALIGN_CENTER
- * @see #ALIGN_RIGHT
- * @see #ALIGN_FILL
- * @see #ALIGN_JUSTIFY
- * @see #ALIGN_CENTER_SELECTION
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_GENERAL
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_LEFT
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_CENTER
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_RIGHT
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_FILL
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_JUSTIFY
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_CENTER_SELECTION
*/
public short getAlignment() {
return (short)(getAlignmentEnum().ordinal());
@@ -136,6 +136,7 @@
* Get the type of horizontal alignment for the cell
*
* @return HorizontalAlignment - the type of alignment
+ * @see org.apache.poi.ss.usermodel.HorizontalAlignment
*/
public HorizontalAlignment getAlignmentEnum() {
CTCellAlignment align = cellXf.getAlignment();
@@ -150,20 +151,20 @@
* Get the type of border to use for the bottom border of the cell
*
* @return short - border type
- * @see #BORDER_NONE
- * @see #BORDER_THIN
- * @see #BORDER_MEDIUM
- * @see #BORDER_DASHED
- * @see #BORDER_DOTTED
- * @see #BORDER_THICK
- * @see #BORDER_DOUBLE
- * @see #BORDER_HAIR
- * @see #BORDER_MEDIUM_DASHED
- * @see #BORDER_DASH_DOT
- * @see #BORDER_MEDIUM_DASH_DOT
- * @see #BORDER_DASH_DOT_DOT
- * @see #BORDER_MEDIUM_DASH_DOT_DOT
- * @see #BORDER_SLANTED_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT
*/
public short getBorderBottom() {
if(!cellXf.getApplyBorder()) return BORDER_NONE;
@@ -188,21 +189,21 @@
/**
* Get the type of border to use for the left border of the cell
*
- * @return short - border type, default value is {@link #BORDER_NONE}
- * @see #BORDER_NONE
- * @see #BORDER_THIN
- * @see #BORDER_MEDIUM
- * @see #BORDER_DASHED
- * @see #BORDER_DOTTED
- * @see #BORDER_THICK
- * @see #BORDER_DOUBLE
- * @see #BORDER_HAIR
- * @see #BORDER_MEDIUM_DASHED
- * @see #BORDER_DASH_DOT
- * @see #BORDER_MEDIUM_DASH_DOT
- * @see #BORDER_DASH_DOT_DOT
- * @see #BORDER_MEDIUM_DASH_DOT_DOT
- * @see #BORDER_SLANTED_DASH_DOT
+ * @return short - border type, default value is {@link org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE}
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT
*/
public short getBorderLeft() {
if(!cellXf.getApplyBorder()) return BORDER_NONE;
@@ -216,7 +217,7 @@
/**
* Get the type of border to use for the left border of the cell
*
- * @return border type, default value is {@link BorderStyle.NONE}
+ * @return border type, default value is {@link org.apache.poi.ss.usermodel.BorderStyle#NONE}
*/
public BorderStyle getBorderLeftEnum() {
int style = getBorderLeft();
@@ -226,21 +227,21 @@
/**
* Get the type of border to use for the right border of the cell
*
- * @return short - border type, default value is {@link #BORDER_NONE}
- * @see #BORDER_NONE
- * @see #BORDER_THIN
- * @see #BORDER_MEDIUM
- * @see #BORDER_DASHED
- * @see #BORDER_DOTTED
- * @see #BORDER_THICK
- * @see #BORDER_DOUBLE
- * @see #BORDER_HAIR
- * @see #BORDER_MEDIUM_DASHED
- * @see #BORDER_DASH_DOT
- * @see #BORDER_MEDIUM_DASH_DOT
- * @see #BORDER_DASH_DOT_DOT
- * @see #BORDER_MEDIUM_DASH_DOT_DOT
- * @see #BORDER_SLANTED_DASH_DOT
+ * @return short - border type, default value is {@link org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE}
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT
*/
public short getBorderRight() {
if(!cellXf.getApplyBorder()) return BORDER_NONE;
@@ -254,7 +255,7 @@
/**
* Get the type of border to use for the right border of the cell
*
- * @return border type, default value is {@link BorderStyle.NONE}
+ * @return border type, default value is {@link org.apache.poi.ss.usermodel.BorderStyle#NONE}
*/
public BorderStyle getBorderRightEnum() {
int style = getBorderRight();
@@ -264,21 +265,21 @@
/**
* Get the type of border to use for the top border of the cell
*
- * @return short - border type, default value is {@link #BORDER_NONE}
- * @see #BORDER_NONE
- * @see #BORDER_THIN
- * @see #BORDER_MEDIUM
- * @see #BORDER_DASHED
- * @see #BORDER_DOTTED
- * @see #BORDER_THICK
- * @see #BORDER_DOUBLE
- * @see #BORDER_HAIR
- * @see #BORDER_MEDIUM_DASHED
- * @see #BORDER_DASH_DOT
- * @see #BORDER_MEDIUM_DASH_DOT
- * @see #BORDER_DASH_DOT_DOT
- * @see #BORDER_MEDIUM_DASH_DOT_DOT
- * @see #BORDER_SLANTED_DASH_DOT
+ * @return short - border type, default value is {@link org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE}
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED
+ * @see org.apache.poi.ss.usermodel.CellStyle #BORDER_THICK
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT
*/
public short getBorderTop() {
if(!cellXf.getApplyBorder()) return BORDER_NONE;
@@ -292,7 +293,7 @@
/**
* Get the type of border to use for the top border of the cell
*
- * @return border type, default value is {@link BorderStyle.NONE}
+ * @return border type, default value is {@link org.apache.poi.ss.usermodel.BorderStyle#NONE}
*/
public BorderStyle getBorderTopEnum() {
int style = getBorderTop();
@@ -303,8 +304,8 @@
* Get the color to use for the bottom border
* <br/>
* 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 IndexedColors
+ * @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
*/
public short getBottomBorderColor() {
XSSFColor clr = getBottomBorderXSSFColor();
@@ -350,8 +351,8 @@
* Note - many cells are actually filled with a foreground
* fill, not a background fill - see {@link #getFillForegroundColor()}
* </p>
- * @return fill color, default value is {@link IndexedColors.AUTOMATIC}
- * @see IndexedColors
+ * @return fill color, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#AUTOMATIC}
+ * @see org.apache.poi.ss.usermodel.IndexedColors
*/
public short getFillBackgroundColor() {
XSSFColor clr = getFillBackgroundXSSFColor();
@@ -383,7 +384,7 @@
* background color ({@link #getFillBackgroundColor()})
* </p>
* @see IndexedColors
- * @return fill color, default value is {@link IndexedColors.AUTOMATIC}
+ * @return fill color, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#AUTOMATIC}
*/
public short getFillForegroundColor() {
XSSFColor clr = getFillForegroundXSSFColor();
@@ -406,25 +407,25 @@
/**
* Get the fill pattern
- * @return fill pattern, default value is {@link #NO_FILL}
+ * @return fill pattern, default value is {@link org.apache.poi.ss.usermodel.CellStyle#NO_FILL}
*
- * @see #NO_FILL
- * @see #SOLID_FOREGROUND
- * @see #FINE_DOTS
- * @see #ALT_BARS
- * @see #SPARSE_DOTS
- * @see #THICK_HORZ_BANDS
- * @see #THICK_VERT_BANDS
- * @see #THICK_BACKWARD_DIAG
- * @see #THICK_FORWARD_DIAG
- * @see #BIG_SPOTS
- * @see #BRICKS
- * @see #THIN_HORZ_BANDS
- * @see #THIN_VERT_BANDS
- * @see #THIN_BACKWARD_DIAG
- * @see #THIN_FORWARD_DIAG
- * @see #SQUARES
- * @see #DIAMONDS
+ * @see org.apache.poi.ss.usermodel.CellStyle#NO_FILL
+ * @see org.apache.poi.ss.usermodel.CellStyle#SOLID_FOREGROUND
+ * @see org.apache.poi.ss.usermodel.CellStyle#FINE_DOTS
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALT_BARS
+ * @see org.apache.poi.ss.usermodel.CellStyle#SPARSE_DOTS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THICK_HORZ_BANDS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THICK_VERT_BANDS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THICK_BACKWARD_DIAG
+ * @see org.apache.poi.ss.usermodel.CellStyle#THICK_FORWARD_DIAG
+ * @see org.apache.poi.ss.usermodel.CellStyle#BIG_SPOTS
+ * @see org.apache.poi.ss.usermodel.CellStyle#BRICKS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THIN_HORZ_BANDS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THIN_VERT_BANDS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THIN_BACKWARD_DIAG
+ * @see org.apache.poi.ss.usermodel.CellStyle#THIN_FORWARD_DIAG
+ * @see org.apache.poi.ss.usermodel.CellStyle#SQUARES
+ * @see org.apache.poi.ss.usermodel.CellStyle#DIAMONDS
*/
public short getFillPattern() {
if(!cellXf.getApplyFill()) return 0;
@@ -440,7 +441,7 @@
/**
* Get the fill pattern
*
- * @return the fill pattern, default value is {@link FillPatternType.NO_FILL}
+ * @return the fill pattern, default value is {@link org.apache.poi.ss.usermodel.FillPatternType#NO_FILL}
*/
public FillPatternType getFillPatternEnum() {
int style = getFillPattern();
@@ -499,8 +500,8 @@
/**
* Get the color to use for the left border
*
- * @return the index of the color definition, default value is {@link IndexedColors.BLACK}
- * @see IndexedColors
+ * @return the index of the color definition, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#BLACK}
+ * @see org.apache.poi.ss.usermodel.IndexedColors
*/
public short getLeftBorderColor() {
XSSFColor clr = getLeftBorderXSSFColor();
@@ -511,7 +512,7 @@
* Get the color to use for the left border
*
* @return the index of the color definition or <code>null</code> if not set
- * @see IndexedColors
+ * @see org.apache.poi.ss.usermodel.IndexedColors
*/
public XSSFColor getLeftBorderXSSFColor() {
if(!cellXf.getApplyBorder()) return null;
@@ -534,8 +535,8 @@
/**
* Get the color to use for the right border
*
- * @return the index of the color definition, default value is {@link IndexedColors.BLACK}
- * @see IndexedColors
+ * @return the index of the color definition, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#BLACK}
+ * @see org.apache.poi.ss.usermodel.IndexedColors
*/
public short getRightBorderColor() {
XSSFColor clr = getRightBorderXSSFColor();
@@ -577,8 +578,8 @@
/**
* Get the color to use for the top border
*
- * @return the index of the color definition, default value is {@link IndexedColors.BLACK}
- * @see IndexedColors
+ * @return the index of the color definition, default value is {@link org.apache.poi.ss.usermodel.IndexedColors#BLACK}
+ * @see org.apache.poi.ss.usermodel.IndexedColors
*/
public short getTopBorderColor() {
XSSFColor clr = getTopBorderXSSFColor();
@@ -602,11 +603,11 @@
/**
* Get the type of vertical alignment for the cell
*
- * @return align the type of alignment, default value is {@link #VERTICAL_BOTTOM}
- * @see #VERTICAL_TOP
- * @see #VERTICAL_CENTER
- * @see #VERTICAL_BOTTOM
- * @see #VERTICAL_JUSTIFY
+ * @return align the type of alignment, default value is {@link org.apache.poi.ss.usermodel.CellStyle#VERTICAL_BOTTOM}
+ * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_TOP
+ * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_CENTER
+ * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_BOTTOM
+ * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_JUSTIFY
*/
public short getVerticalAlignment() {
return (short) (getVerticalAlignmentEnum().ordinal());
@@ -615,8 +616,8 @@
/**
* Get the type of vertical alignment for the cell
*
- * @return the type of alignment, default value is {@link VerticalAlignment.BOTTOM}
- * @see VerticalAlignment
+ * @return the type of alignment, default value is {@link org.apache.poi.ss.usermodel.VerticalAlignment#BOTTOM}
+ * @see org.apache.poi.ss.usermodel.VerticalAlignment
*/
public VerticalAlignment getVerticalAlignmentEnum() {
CTCellAlignment align = cellXf.getAlignment();
@@ -641,13 +642,13 @@
* Set the type of horizontal alignment for the cell
*
* @param align - the type of alignment
- * @see #ALIGN_GENERAL
- * @see #ALIGN_LEFT
- * @see #ALIGN_CENTER
- * @see #ALIGN_RIGHT
- * @see #ALIGN_FILL
- * @see #ALIGN_JUSTIFY
- * @see #ALIGN_CENTER_SELECTION
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_GENERAL
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_LEFT
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_CENTER
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_RIGHT
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_FILL
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_JUSTIFY
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALIGN_CENTER_SELECTION
*/
public void setAlignment(short align) {
getCellAlignment().setHorizontal(HorizontalAlignment.values()[align]);
@@ -667,20 +668,20 @@
* Set the type of border to use for the bottom border of the cell
*
* @param border the type of border to use
- * @see #BORDER_NONE
- * @see #BORDER_THIN
- * @see #BORDER_MEDIUM
- * @see #BORDER_DASHED
- * @see #BORDER_DOTTED
- * @see #BORDER_THICK
- * @see #BORDER_DOUBLE
- * @see #BORDER_HAIR
- * @see #BORDER_MEDIUM_DASHED
- * @see #BORDER_DASH_DOT
- * @see #BORDER_MEDIUM_DASH_DOT
- * @see #BORDER_DASH_DOT_DOT
- * @see #BORDER_MEDIUM_DASH_DOT_DOT
- * @see #BORDER_SLANTED_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT
*/
public void setBorderBottom(short border) {
CTBorder ct = getCTBorder();
@@ -698,7 +699,7 @@
* Set the type of border to use for the bottom border of the cell
*
* @param border - type of border to use
- * @see BorderStyle
+ * @see org.apache.poi.ss.usermodel.BorderStyle
*/
public void setBorderBottom(BorderStyle border) {
setBorderBottom((short)border.ordinal());
@@ -707,20 +708,20 @@
/**
* Set the type of border to use for the left border of the cell
* @param border the type of border to use
- * @see #BORDER_NONE
- * @see #BORDER_THIN
- * @see #BORDER_MEDIUM
- * @see #BORDER_DASHED
- * @see #BORDER_DOTTED
- * @see #BORDER_THICK
- * @see #BORDER_DOUBLE
- * @see #BORDER_HAIR
- * @see #BORDER_MEDIUM_DASHED
- * @see #BORDER_DASH_DOT
- * @see #BORDER_MEDIUM_DASH_DOT
- * @see #BORDER_DASH_DOT_DOT
- * @see #BORDER_MEDIUM_DASH_DOT_DOT
- * @see #BORDER_SLANTED_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT
*/
public void setBorderLeft(short border) {
CTBorder ct = getCTBorder();
@@ -747,20 +748,20 @@
* Set the type of border to use for the right border of the cell
*
* @param border the type of border to use
- * @see #BORDER_NONE
- * @see #BORDER_THIN
- * @see #BORDER_MEDIUM
- * @see #BORDER_DASHED
- * @see #BORDER_DOTTED
- * @see #BORDER_THICK
- * @see #BORDER_DOUBLE
- * @see #BORDER_HAIR
- * @see #BORDER_MEDIUM_DASHED
- * @see #BORDER_DASH_DOT
- * @see #BORDER_MEDIUM_DASH_DOT
- * @see #BORDER_DASH_DOT_DOT
- * @see #BORDER_MEDIUM_DASH_DOT_DOT
- * @see #BORDER_SLANTED_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT
*/
public void setBorderRight(short border) {
CTBorder ct = getCTBorder();
@@ -787,20 +788,20 @@
* Set the type of border to use for the top border of the cell
*
* @param border the type of border to use
- * @see #BORDER_NONE
- * @see #BORDER_THIN
- * @see #BORDER_MEDIUM
- * @see #BORDER_DASHED
- * @see #BORDER_DOTTED
- * @see #BORDER_THICK
- * @see #BORDER_DOUBLE
- * @see #BORDER_HAIR
- * @see #BORDER_MEDIUM_DASHED
- * @see #BORDER_DASH_DOT
- * @see #BORDER_MEDIUM_DASH_DOT
- * @see #BORDER_DASH_DOT_DOT
- * @see #BORDER_MEDIUM_DASH_DOT_DOT
- * @see #BORDER_SLANTED_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_NONE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THIN
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOTTED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_THICK
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DOUBLE
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_HAIR
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASHED
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_MEDIUM_DASH_DOT_DOT
+ * @see org.apache.poi.ss.usermodel.CellStyle#BORDER_SLANTED_DASH_DOT
*/
public void setBorderTop(short border) {
CTBorder ct = getCTBorder();
@@ -826,7 +827,7 @@
/**
* Set the color to use for the bottom border
* @param color the index of the color definition
- * @see IndexedColors
+ * @see org.apache.poi.ss.usermodel.IndexedColors
*/
public void setBottomBorderColor(short color) {
XSSFColor clr = new XSSFColor();
@@ -928,7 +929,7 @@
* for the color to be shown in the cell.
*
* @param bg - the color to use
- * @see IndexedColors
+ * @see org.apache.poi.ss.usermodel.IndexedColors
*/
public void setFillBackgroundColor(short bg) {
XSSFColor clr = new XSSFColor();
@@ -965,7 +966,7 @@
* <br/>
* <i>Note: Ensure Foreground color is set prior to background color.</i>
* @param fg the color to use
- * @see IndexedColors
+ * @see org.apache.poi.ss.usermodel.IndexedColors
*/
public void setFillForegroundColor(short fg) {
XSSFColor clr = new XSSFColor();
@@ -1010,26 +1011,26 @@
* For solid cell fills (no pattern), foregorund color is used.
* For cell fills with patterns specified, then the cell fill color is specified by the background color.
*
- * @see #NO_FILL
- * @see #SOLID_FOREGROUND
- * @see #FINE_DOTS
- * @see #ALT_BARS
- * @see #SPARSE_DOTS
- * @see #THICK_HORZ_BANDS
- * @see #THICK_VERT_BANDS
- * @see #THICK_BACKWARD_DIAG
- * @see #THICK_FORWARD_DIAG
- * @see #BIG_SPOTS
- * @see #BRICKS
- * @see #THIN_HORZ_BANDS
- * @see #THIN_VERT_BANDS
- * @see #THIN_BACKWARD_DIAG
- * @see #THIN_FORWARD_DIAG
- * @see #SQUARES
- * @see #DIAMONDS
+ * @see org.apache.poi.ss.usermodel.CellStyle#NO_FILL
+ * @see org.apache.poi.ss.usermodel.CellStyle#SOLID_FOREGROUND
+ * @see org.apache.poi.ss.usermodel.CellStyle#FINE_DOTS
+ * @see org.apache.poi.ss.usermodel.CellStyle#ALT_BARS
+ * @see org.apache.poi.ss.usermodel.CellStyle#SPARSE_DOTS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THICK_HORZ_BANDS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THICK_VERT_BANDS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THICK_BACKWARD_DIAG
+ * @see org.apache.poi.ss.usermodel.CellStyle#THICK_FORWARD_DIAG
+ * @see org.apache.poi.ss.usermodel.CellStyle#BIG_SPOTS
+ * @see org.apache.poi.ss.usermodel.CellStyle#BRICKS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THIN_HORZ_BANDS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THIN_VERT_BANDS
+ * @see org.apache.poi.ss.usermodel.CellStyle#THIN_BACKWARD_DIAG
+ * @see org.apache.poi.ss.usermodel.CellStyle#THIN_FORWARD_DIAG
+ * @see org.apache.poi.ss.usermodel.CellStyle#SQUARES
+ * @see org.apache.poi.ss.usermodel.CellStyle#DIAMONDS
* @see #setFillBackgroundColor(short)
* @see #setFillForegroundColor(short)
- * @param fp fill pattern (set to {@link #SOLID_FOREGROUND} to fill w/foreground color)
+ * @param fp fill pattern (set to {@link org.apache.poi.ss.usermodel.CellStyle#SOLID_FOREGROUND} to fill w/foreground color)
*/
public void setFillPattern(short fp) {
CTFill ct = getCTFill();
@@ -1050,7 +1051,7 @@
* @param ptrn the fill pattern to use
* @see #setFillBackgroundColor(short)
* @see #setFillForegroundColor(short)
- * @see FillPatternType
+ * @see org.apache.poi.ss.usermodel.FillPatternType
*/
public void setFillPattern(FillPatternType ptrn) {
setFillPattern((short)ptrn.ordinal());
@@ -1095,7 +1096,7 @@
* Set the color to use for the left border as a indexed color value
*
* @param color the index of the color definition
- * @see IndexedColors
+ * @see org.apache.poi.ss.usermodel.IndexedColors
*/
public void setLeftBorderColor(short color) {
XSSFColor clr = new XSSFColor();
@@ -1135,7 +1136,7 @@
* Set the color to use for the right border
*
* @param color the index of the color definition
- * @see IndexedColors
+ * @see org.apache.poi.ss.usermodel.IndexedColors
*/
public void setRightBorderColor(short color) {
XSSFColor clr = new XSSFColor();
@@ -1216,11 +1217,11 @@
* Set the type of vertical alignment for the cell
*
* @param align - align the type of alignment
- * @see #VERTICAL_TOP
- * @see #VERTICAL_CENTER
- * @see #VERTICAL_BOTTOM
- * @see #VERTICAL_JUSTIFY
- * @see VerticalAlignment
+ * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_TOP
+ * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_CENTER
+ * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_BOTTOM
+ * @see org.apache.poi.ss.usermodel.CellStyle#VERTICAL_JUSTIFY
+ * @see org.apache.poi.ss.usermodel.VerticalAlignment
*/
public void setVerticalAlignment(short align) {
getCellAlignment().setVertical(VerticalAlignment.values()[align]);
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org