moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Some javadoc fixes... eek

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352090 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Glen Stampoultzis 2002-02-11 10:45:51 +00:00
parent 584a087e9f
commit b273ee7ac6
40 changed files with 144 additions and 149 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/java/org/apache/poi/hssf/model/Sheet.java
View File

@ -116,7 +116,7 @@ public class Sheet
/**
* Creates new Sheet with no intialization --useless at this point
* @see #createSheet(Record[],int,int)
* @see #createSheet(List,int,int)
*/
public Sheet()
@ -140,7 +140,6 @@ public class Sheet
* @see org.apache.poi.hssf.model.Workbook
* @see org.apache.poi.hssf.record.Record
*/
public static Sheet createSheet(List recs, int sheetnum, int offset)
{
log.logFormatted(log.DEBUG,
@ -240,7 +239,7 @@ public class Sheet
* read support (offset = 0) Same as createSheet(Record[] recs, int, int)
* only the record offset is assumed to be 0.
*
* @param recs array containing those records in the sheet in sequence (normally obtained from RecordFactory)
* @param records 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)
* @return Sheet object
*/
@ -553,7 +552,7 @@ public class Sheet
* the sheet out.
*
* @param offset to begin write at
* @param byte[] array containing the binary representation of the records in this sheet
* @param data array containing the binary representation of the records in this sheet
*
*/
@ -563,7 +562,7 @@ public class Sheet
// addDBCellRecords();
// ArrayList bytes = new ArrayList(4096);
int arraysize = getSize(); // 0;
// int arraysize = getSize(); // 0;
int pos = 0;
// for (int k = 0; k < records.size(); k++)
@ -879,7 +878,7 @@ public class Sheet
{
d.setFirstRow(row.getRowNumber());
}
IndexRecord index = null;
//IndexRecord index = null;
rows.insertRow(row);
@ -926,13 +925,13 @@ public class Sheet
*
* This method is not loc sensitive, it resets loc to = dimsloc so no worries.
*
* @param the row record to remove
* @param row the row record to remove
*/
public void removeRow(RowRecord row)
{
checkRows();
IndexRecord index = null;
// IndexRecord index = null;
setLoc(getDimsLoc());
rows.removeRow(row);
@ -1102,7 +1101,7 @@ public class Sheet
* at what this sets it to. For this method, set loc to dimsloc to start with.
* subsequent calls will return rows in (physical) sequence or NULL when you get to the end.
*
* @param row number - which row to return (careful with LOC)
* @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)
*
@ -1145,8 +1144,8 @@ public class Sheet
int offset = 0;
int recnum = 0;
int rownum = 0;
int lastrow = 0;
long lastrowoffset = 0;
//int lastrow = 0;
//long lastrowoffset = 0;
IndexRecord index = null;
// ArrayList rowOffsets = new ArrayList();
@ -1622,7 +1621,7 @@ public class Sheet
/**
* set the default column width for the sheet (if the columns do not define their own width)
* @param default column width
* @param dcw default column width
*/
public void setDefaultColumnWidth(short dcw)
@ -1632,7 +1631,6 @@ public class Sheet
/**
* set the default row height for the sheet (if the rows do not define their own height)
* @return default row height
*/
public void setDefaultRowHeight(short dch)
@ -1642,7 +1640,7 @@ public class Sheet
/**
* get the default row height for the sheet (if the rows do not define their own height)
* @param default row height
* @return default row height
*/
public short getDefaultRowHeight()
@ -1704,7 +1702,7 @@ public class Sheet
{
columnSizes = new ArrayList();
}
int cioffset = getDimsLoc() - columnSizes.size();
//int cioffset = getDimsLoc() - columnSizes.size();
for (k = 0; k < columnSizes.size(); k++)
{

4
src/java/org/apache/poi/hssf/record/BoundSheetRecord.java
View File

@ -132,7 +132,7 @@ public class BoundSheetRecord
/**
* set the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file
*
* @param offset in bytes
* @param pos offset in bytes
*/
public void setPositionOfBof(int pos)
@ -154,7 +154,7 @@ public class BoundSheetRecord
/**
* Set the length of the sheetname in characters
*
* @param number of characters in the sheet name
* @param len number of characters in the sheet name
* @see #setSheetname(String)
*/

6
src/java/org/apache/poi/hssf/record/CellValueRecordInterface.java
View File

@ -113,7 +113,7 @@ public interface CellValueRecordInterface
/**
* returns whether this cell is before the passed in cell
*
* @param cellinterface another cell interface record to compare
* @param i another cell interface record to compare
* @return true if the cells is before, or false if not
*/
@ -122,7 +122,7 @@ public interface CellValueRecordInterface
/**
* returns whether this cell is after the passed in cell
*
* @param cellinterface record to compare
* @param i record to compare
* @return true if the cell is after, false if not
*/
@ -131,7 +131,7 @@ public interface CellValueRecordInterface
/**
* returns whether this cell represents the same cell (NOT VALUE)
*
* @param cellinterface record to compare
* @param i record to compare
* @return true if the cells are the same cell (positionally), false if not.
*/

13
src/java/org/apache/poi/hssf/record/ContinueRecord.java
View File

@ -209,11 +209,11 @@ public class ContinueRecord
/**
* Fill the fields. Only thing is, this record has no fields --
*
* @param ignored_parm1
* @param ignored_parm2
* @param ignored_parm1 Ignored
* @param ignored_parm2 Ignored
*/
protected void fillFields(byte [] data, short ignored_parm2)
protected void fillFields(byte [] ignored_parm1, short ignored_parm2)
{
// throw new RecordFormatException("Are you crazy? Don't fill a continue record");
@ -259,11 +259,12 @@ public class ContinueRecord
/**
* Fill the fields. Only thing is, this record has no fields --
*
* @param ignored_parm1
* @param ignored_parm2
* @param ignored_parm1 Ignored
* @param ignored_parm2 Ignored
* @param ignored_parm3 Ignored
*/
protected void fillFields(byte [] data, short size, int offset)
protected void fillFields(byte [] ignored_parm1, short ignored_parm2, int ignored_parm3)
{
}
}

2
src/java/org/apache/poi/hssf/record/DefaultColWidthRecord.java
View File

@ -119,7 +119,7 @@ public class DefaultColWidthRecord
/**
* set the default column width
* @param defaultwidth for columns
* @param height defaultwidth for columns
*/
public void setColWidth(short height)

2
src/java/org/apache/poi/hssf/record/DimensionsRecord.java
View File

@ -156,7 +156,7 @@ public class DimensionsRecord
/**
* set the last col number for the sheet
* @param column - last column on the sheet
* @param col last column on the sheet
*/
public void setLastCol(short col)

12
src/java/org/apache/poi/hssf/record/FontRecord.java
View File

@ -178,7 +178,7 @@ public class FontRecord
/**
* sets the height of the font in 1/20th point units
*
* @param fontheight (in points/20)
* @param height fontheight (in points/20)
*/
public void setFontHeight(short height)
@ -189,7 +189,7 @@ public class FontRecord
/**
* set the font attributes (see individual bit setters that reference this method)
*
* @param attribute the bitmask to set
* @param attributes the bitmask to set
*/
public void setAttributes(short attributes)
@ -275,7 +275,7 @@ public class FontRecord
/**
* set the type of super or subscript for the font
*
* @param super or subscript option
* @param sss super or subscript option
* @see #SS_NONE
* @see #SS_SUPER
* @see #SS_SUB
@ -289,7 +289,7 @@ public class FontRecord
/**
* set the type of underlining for the font
*
* @param super or subscript option
* @param u super or subscript option
*
* @see #U_NONE
* @see #U_SINGLE
@ -306,7 +306,7 @@ public class FontRecord
/**
* set the font family (TODO)
*
* @param family
* @param f family
*/
public void setFamily(byte f)
@ -328,7 +328,7 @@ public class FontRecord
/**
* set the length of the fontname string
*
* @param length of the font name
* @param len length of the font name
* @see #setFontName(String)
*/

2
src/java/org/apache/poi/hssf/record/FooterRecord.java
View File

@ -125,7 +125,7 @@ public class FooterRecord
/**
* set the length of the footer string
*
* @param length of the footer string
* @param len length of the footer string
* @see #setFooter(String)
*/

6
src/java/org/apache/poi/hssf/record/FormatRecord.java
View File

@ -127,7 +127,7 @@ public class FormatRecord
/**
* set the format index code (for built in formats)
*
* @param the format index code
* @param index the format index code
* @see org.apache.poi.hssf.model.Workbook
*/
@ -139,7 +139,7 @@ public class FormatRecord
/**
* set the format string length
*
* @param the length of the format string
* @param len the length of the format string
* @see #setFormatString(String)
*/
@ -151,7 +151,7 @@ public class FormatRecord
/**
* set the format string
*
* @param the format string
* @param fs the format string
* @see #setFormatStringLength(byte)
*/

8
src/java/org/apache/poi/hssf/record/FormulaRecord.java
View File

@ -172,7 +172,7 @@ public class FormulaRecord
/**
* set the calculated value of the formula
*
* @param calculated value
* @param value calculated value
*/
public void setValue(double value)
@ -183,7 +183,7 @@ public class FormulaRecord
/**
* set the option flags
*
* @param bitmask
* @param options bitmask
*/
public void setOptions(short options)
@ -193,7 +193,7 @@ public class FormulaRecord
/**
* set the length (in number of tokens) of the expression
* @param length
* @param len length
*/
public void setExpressionLength(short len)
@ -251,7 +251,7 @@ public class FormulaRecord
/**
* push a token onto the stack
*
* @param Ptg - the token
* @param ptg the token
*/
public void pushExpressionToken(Ptg ptg)

8
src/java/org/apache/poi/hssf/record/GutsRecord.java
View File

@ -124,7 +124,7 @@ public class GutsRecord
/**
* set the size of the gutter that appears at the left of the rows
*
* @param gutter size in screen units
* @param gut gutter size in screen units
*/
public void setLeftRowGutter(short gut)
@ -135,7 +135,7 @@ public class GutsRecord
/**
* set the size of the gutter that appears at the above the columns
*
* @param gutter size in screen units
* @param gut gutter size in screen units
*/
public void setTopColGutter(short gut)
@ -146,7 +146,7 @@ public class GutsRecord
/**
* set the maximum outline level for the row gutter.
*
* @param maximum outline level
* @param max maximum outline level
*/
public void setRowLevelMax(short max)
@ -157,7 +157,7 @@ public class GutsRecord
/**
* set the maximum outline level for the col gutter.
*
* @param maximum outline level
* @param max maximum outline level
*/
public void setColLevelMax(short max)

2
src/java/org/apache/poi/hssf/record/HCenterRecord.java
View File

@ -117,7 +117,7 @@ public class HCenterRecord
/**
* set whether or not to horizonatally center this sheet.
* @param center - t/f
* @param hc center - t/f
*/
public void setHCenter(boolean hc)

2
src/java/org/apache/poi/hssf/record/HeaderRecord.java
View File

@ -125,7 +125,7 @@ public class HeaderRecord
/**
* set the length of the header string
*
* @param length of the header string
* @param len length of the header string
* @see #setHeader(String)
*/

4
src/java/org/apache/poi/hssf/record/MMSRecord.java
View File

@ -120,7 +120,7 @@ public class MMSRecord
/**
* set number of add menu options (set to 0)
* @param number of add menu options
* @param am number of add menu options
*/
public void setAddMenuCount(byte am)
@ -130,7 +130,7 @@ public class MMSRecord
/**
* set number of del menu options (set to 0)
* @param number of add menu options
* @param dm number of del menu options
*/
public void setDelMenuCount(byte dm)

6
src/java/org/apache/poi/hssf/record/MergeCellsRecord.java
View File

@ -82,7 +82,7 @@ public class MergeCellsRecord
/**
* Constructs a MergedCellsRecord and sets its fields appropriately
*
* @param id id must be 0xe5 or an exception will be throw upon validation
* @param sid id must be 0xe5 or an exception will be throw upon validation
* @param size the size of the data area of the record
* @param data data of the record (should not contain sid/len)
*/
@ -95,7 +95,7 @@ public class MergeCellsRecord
/**
* Constructs a MergedCellsRecord and sets its fields appropriately
*
* @param id id must be 0xe5 or an exception will be throw upon validation
* @param sid id must be 0xe5 or an exception will be throw upon validation
* @param size the size of the data area of the record
* @param data data of the record (should not contain sid/len)
* @param offset the offset of the record's data
@ -143,7 +143,7 @@ public class MergeCellsRecord
* you are setting this to 0 then you are a terrible person. Just remove the record.
* (just kidding about you being a terrible person..hehe)
*
* @param number of areas
* @param numareas number of areas
*/
public void setNumAreas(short numareas)

4
src/java/org/apache/poi/hssf/record/NumberRecord.java
View File

@ -142,7 +142,7 @@ public class NumberRecord
/**
* set the index to the ExtendedFormat
* @see org.apache.poi.hssf.record.ExtendedFormatRecord
* @param index to the XF record
* @param xf index to the XF record
*/
public void setXFIndex(short xf)
@ -153,7 +153,7 @@ public class NumberRecord
/**
* set the value for the cell
*
* @param double representing the value
* @param value double representing the value
*/
public void setValue(double value)

2
src/java/org/apache/poi/hssf/record/PasswordRecord.java
View File

@ -118,7 +118,7 @@ public class PasswordRecord
/**
* set the password
*
* @param short representing the password
* @param password representing the password
*/
public void setPassword(short password)

2
src/java/org/apache/poi/hssf/record/PasswordRev4Record.java
View File

@ -119,7 +119,7 @@ public class PasswordRev4Record
/**
* set the password
*
* @param short representing the password
* @param pw representing the password
*/
public void setPassword(short pw)

2
src/java/org/apache/poi/hssf/record/PrintGridlinesRecord.java
View File

@ -119,7 +119,7 @@ public class PrintGridlinesRecord
/**
* set whether or not to print the gridlines (and make your spreadsheet ugly)
*
* @param make spreadsheet ugly - Y/N
* @param pg make spreadsheet ugly - Y/N
*/
public void setPrintGridlines(boolean pg)

2
src/java/org/apache/poi/hssf/record/PrintHeadersRecord.java
View File

@ -118,7 +118,7 @@ public class PrintHeadersRecord
/**
* set to print the headers - y/n
* @param printheaders or not
* @param p printheaders or not
*/
public void setPrintHeaders(boolean p)

2
src/java/org/apache/poi/hssf/record/ProtectionRev4Record.java
View File

@ -119,7 +119,7 @@ public class ProtectionRev4Record
/**
* set whether the this is protected shared/tracked workbook or not
* @param whether to protect the workbook or not
* @param protect whether to protect the workbook or not
*/
public void setProtect(boolean protect)

2
src/java/org/apache/poi/hssf/record/Record.java
View File

@ -175,7 +175,7 @@ public abstract class Record
* byte array.
*
* @param offset to begin writing at
* @param byte array containing instance data
* @param data byte array containing instance data
* @return number of bytes written
*/

2
src/java/org/apache/poi/hssf/record/RefModeRecord.java
View File

@ -119,7 +119,7 @@ public class RefModeRecord
/**
* set the reference mode to use (HSSF uses/assumes A1)
* @param the mode to use
* @param mode the mode to use
* @see #USE_A1_MODE
* @see #USE_R1C1_MODE
*

6
src/java/org/apache/poi/hssf/record/RowRecord.java
View File

@ -229,7 +229,7 @@ public class RowRecord
/**
* set whether or not to display this row with 0 height
* @param - z height is zero or not.
* @param z height is zero or not.
* @see #setOptionFlags(short)
*/
@ -241,7 +241,7 @@ public class RowRecord
/**
* set whether the font and row height are not compatible
* @param - f -true if they aren't compatible (damn not logic)
* @param f true if they aren't compatible (damn not logic)
* @see #setOptionFlags(short)
*/
@ -253,7 +253,7 @@ public class RowRecord
/**
* set whether the row has been formatted (even if its got all blank cells)
* @param formatted or not
* @param f formatted or not
* @see #setOptionFlags(short)
*/

12
src/java/org/apache/poi/hssf/record/SSTRecord.java
View File

@ -294,9 +294,8 @@ public class SSTRecord
* WRONG AND WILL RESULT IN BAD BEHAVIOR WHEN THIS RECORD IS
* WRITTEN OUT AND ANOTHER PROCESS ATTEMPTS TO READ THE RECORD
*
* @param number of strings
* @param count number of strings
*
* @param count
*/
public void setNumStrings(final int count)
@ -312,9 +311,7 @@ public class SSTRecord
* THIS RECORD IS WRITTEN OUT AND ANOTHER PROCESS ATTEMPTS TO READ
* THE RECORD
*
* @param number of strings
*
* @param count
* @param count number of strings
*/
public void getNumUniqueStrings(final int count)
@ -421,7 +418,7 @@ public class SSTRecord
pos = 0;
int to_be_written = (unicodesize - stringbyteswritten)
+ (lastneedcontinue ? 1
: 0);
: 0); // not used?
size =
(( Integer ) _record_lengths
@ -527,7 +524,7 @@ public class SSTRecord
{
// short data: write one simple SST record
int datasize = _sst_record_overhead + unicodesize;
int datasize = _sst_record_overhead + unicodesize; // not used?
writeSSTHeader(
data, 0 + offset,
@ -549,6 +546,7 @@ public class SSTRecord
return rval;
}
// not used: remove?
private int calculateStringsize()
{
int retval = 0;

2
src/java/org/apache/poi/hssf/record/SelectionRecord.java
View File

@ -79,7 +79,7 @@ public class SelectionRecord
private short field_3_col_active_cell;
private short field_4_ref_active_cell;
private short field_5_num_refs;
private ArrayList field_6_refs;
private ArrayList field_6_refs; // not used yet
public SelectionRecord()
{

2
src/java/org/apache/poi/hssf/record/StyleRecord.java
View File

@ -143,7 +143,7 @@ public class StyleRecord
/**
* set the entire index field (including the type) (see bit setters that reference this method)
* @param bitmask
* @param index bitmask
*/
public void setIndex(short index)

4
src/java/org/apache/poi/hssf/record/UnicodeString.java
View File

@ -206,7 +206,7 @@ public class UnicodeString
* set the option flags which among other things return if this is a 16-bit or
* 8 bit string
*
* @param optionflags bitmask
* @param of optionflags bitmask
*
*/
@ -230,7 +230,7 @@ public class UnicodeString
/**
* set the actual string this contains
* @param String - the text
* @param string the text
*/
public void setString(String string)

6
src/java/org/apache/poi/hssf/record/UnknownRecord.java
View File

@ -82,9 +82,9 @@ public class UnknownRecord
/**
* construct an unknown record. No fields are interperated and the record will
* be serialized in its original form more or less
* @param id of the record -not validated, just stored for serialization
* @param size of the data
* @param the data
* @param id id of the record -not validated, just stored for serialization
* @param size size of the data
* @param data the data
*/
public UnknownRecord(short id, short size, byte [] data)

2
src/java/org/apache/poi/hssf/record/UseSelFSRecord.java
View File

@ -121,7 +121,7 @@ public class UseSelFSRecord
/**
* turn the flag on or off
*
* @param whether to use natural language formulas or not
* @param flag whether to use natural language formulas or not
* @see #TRUE
* @see #FALSE
*/

2
src/java/org/apache/poi/hssf/record/VCenterRecord.java
View File

@ -117,7 +117,7 @@ public class VCenterRecord
/**
* set whether to center vertically or not
* @param vcenter or not
* @param hc vcenter or not
*/
public void setVCenter(boolean hc)

8
src/java/org/apache/poi/hssf/record/WSBoolRecord.java
View File

@ -166,7 +166,7 @@ public class WSBoolRecord
/**
* show automatic page breaks or not
* @param whether to show auto page breaks
* @param ab whether to show auto page breaks
*/
public void setAutobreaks(boolean ab)
@ -219,7 +219,7 @@ public class WSBoolRecord
/**
* fit to page option is on
* @param fit or not
* @param fit2page fit or not
*/
public void setFitToPage(boolean fit2page)
@ -240,7 +240,7 @@ public class WSBoolRecord
/**
* whether alternate expression evaluation is on
* @param alternative expression evaluation or not
* @param altexp alternative expression evaluation or not
*/
public void setAlternateExpression(boolean altexp)
@ -251,7 +251,7 @@ public class WSBoolRecord
/**
* whether alternative formula entry is on
* @param alternative formulas or not
* @param formula alternative formulas or not
*/
public void setAlternateFormula(boolean formula)

20
src/java/org/apache/poi/hssf/record/WindowOneRecord.java
View File

@ -170,7 +170,7 @@ public class WindowOneRecord
/**
* set the width of the window
* @param width
* @param w width
*/
public void setWidth(short w)
@ -180,7 +180,7 @@ public class WindowOneRecord
/**
* set teh height of the window
* @param height
* @param h height
*/
public void setHeight(short h)
@ -213,7 +213,7 @@ public class WindowOneRecord
/**
* set whether the window has been iconized or not
* @param iconize or not
* @param isiconic iconize or not
*/
public void setIconic(boolean isiconic)
@ -223,7 +223,7 @@ public class WindowOneRecord
/**
* set whether to display the horizontal scrollbar or not
* @param display or not
* @param scroll display or not
*/
public void setDisplayHorizonalScrollbar(boolean scroll)
@ -233,7 +233,7 @@ public class WindowOneRecord
/**
* set whether to display the vertical scrollbar or not
* @param display or not
* @param scroll display or not
*/
public void setDisplayVerticalScrollbar(boolean scroll)
@ -243,7 +243,7 @@ public class WindowOneRecord
/**
* set whether to display the tabs or not
* @param display or not
* @param disptabs display or not
*/
public void setDisplayTabs(boolean disptabs)
@ -255,7 +255,7 @@ public class WindowOneRecord
/**
* set the selected tab number
* @param Tab number
* @param s tab number
*/
public void setSelectedTab(short s)
@ -265,7 +265,7 @@ public class WindowOneRecord
/**
* set the displayed tab number
* @param Tab number
* @param t tab number
*/
public void setDisplayedTab(short t)
@ -275,7 +275,7 @@ public class WindowOneRecord
/**
* set the number of selected tabs
* @param number of tabs
* @param n number of tabs
*/
public void setNumSelectedTabs(short n)
@ -285,7 +285,7 @@ public class WindowOneRecord
/**
* ratio of the width of the tabs to the horizontal scrollbar
* @param ratio
* @param r ratio
*/
public void setTabWidthRatio(short r)

16
src/java/org/apache/poi/hssf/record/WindowTwoRecord.java
View File

@ -202,7 +202,7 @@ public class WindowTwoRecord
/**
* set whether the window should freeze panes
* @param freeze panes or not
* @param freezepanes freeze panes or not
*/
public void setFreezePanes(boolean freezepanes)
@ -232,7 +232,7 @@ public class WindowTwoRecord
/**
* is this arabic?
* @param arabic or not
* @param isarabic arabic or not
*/
public void setArabic(boolean isarabic)
@ -242,7 +242,7 @@ public class WindowTwoRecord
/**
* set whether the outline symbols are displaed
* @param symbols or not
* @param guts symbols or not
*/
public void setDisplayGuts(boolean guts)
@ -262,7 +262,7 @@ public class WindowTwoRecord
/**
* sheet tab is selected
* @param selected or not
* @param sel selected or not
*/
public void setSelected(boolean sel)
@ -272,7 +272,7 @@ public class WindowTwoRecord
/**
* is the sheet currently displayed in the window
* @param displayed or not
* @param p displayed or not
*/
public void setPaged(boolean p)
@ -282,7 +282,7 @@ public class WindowTwoRecord
/**
* was the sheet saved in page break view
* @param pagebreaksaved or not
* @param p pagebreaksaved or not
*/
public void setSavedInPageBreakPreview(boolean p)
@ -294,7 +294,7 @@ public class WindowTwoRecord
/**
* set the top row visible in the window
* @param toprow
* @param topRow top row visible
*/
public void setTopRow(short topRow)
@ -304,7 +304,7 @@ public class WindowTwoRecord
/**
* set the leftmost column displayed in the window
* @param leftmost
* @param leftCol leftmost column
*/
public void setLeftCol(short leftCol)

2
src/java/org/apache/poi/hssf/record/aggregates/ValueRecordsAggregate.java
View File

@ -160,7 +160,7 @@ public class ValueRecordsAggregate
* byte array.
*
* @param offset to begin writing at
* @param byte array containing instance data
* @param data byte array containing instance data
* @return number of bytes written
*/

11
src/java/org/apache/poi/hssf/usermodel/HSSFCell.java
View File

@ -327,16 +327,13 @@ public class HSSFCell
/**
* private constructor to prevent blank construction
*/
private HSSFCell()
{
}
;
/**
* used internally -- given a cell value record, figure out its type
*/
private int determineType(CellValueRecordInterface cval)
{
Record record = ( Record ) cval;
@ -375,7 +372,7 @@ public class HSSFCell
/**
* set the cell's number within the row (0 based)
* @param short the cell number
* @param num short the cell number
*/
public void setCellNum(short num)
@ -607,7 +604,7 @@ public class HSSFCell
/**
* set a numeric value for the cell
*
* @param double the numeric value to set this cell to. For formulas we'll set the
* @param value the numeric value to set this cell to. For formulas we'll set the
* precalculated value, for numerics we'll set its value. For other types we
* will change the cell to a numeric cell and set its value.
*/
@ -626,7 +623,7 @@ public class HSSFCell
/**
* set a string value for the cell.
*
* @param String value to set the cell to. For formulas we'll set the formula
* @param value value to set the cell to. For formulas we'll set the formula
* string, for String cells we'll set its value. For other types we will
* change the cell to a string cell and set its value.
* If value is null then we will change the cell to a Blank cell.
@ -798,7 +795,7 @@ public class HSSFCell
* set the style for the cell. The style should be an HSSFCellStyle created/retreived from
* the HSSFWorkbook.
*
* @param HSSFCellStyle reference contained in the workbook
* @param style reference contained in the workbook
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#createCellStyle()
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#getCellStyleAt(short)
*/

16
src/java/org/apache/poi/hssf/usermodel/HSSFCellStyle.java
View File

@ -271,7 +271,7 @@ public class HSSFCellStyle
/**
* set the font for this style
* @param a font object created or retreived from the HSSFWorkbook object
* @param font a font object created or retreived from the HSSFWorkbook object
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#createFont()
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#getFontAt(short)
*/
@ -379,7 +379,7 @@ public class HSSFCellStyle
/**
* set whether this cell is to be part of a merged block of cells
*
* @param merged or not
* @param merge merged or not
*/
public void setMergeCells(boolean merge)
@ -389,7 +389,7 @@ public class HSSFCellStyle
/**
* set whether the text should be wrapped
* @param wrap text or not
* @param wrapped wrap text or not
*/
public void setWrapText(boolean wrapped)
@ -410,7 +410,7 @@ public class HSSFCellStyle
/**
* set the type of vertical alignment for the cell
* @param align - the type of alignment
* @param align the type of alignment
* @see #VERTICAL_TOP
* @see #VERTICAL_CENTER
* @see #VERTICAL_BOTTOM
@ -424,7 +424,7 @@ public class HSSFCellStyle
/**
* get the type of vertical alignment for the cell
* @return align - the type of alignment
* @return align the type of alignment
* @see #VERTICAL_TOP
* @see #VERTICAL_CENTER
* @see #VERTICAL_BOTTOM
@ -755,7 +755,7 @@ public class HSSFCellStyle
/**
* setting to one fills the cell with the foreground color... No idea about
* other values
* @param fill pattern (set to 1 to fill w/foreground color
* @param fp fill pattern (set to 1 to fill w/foreground color
*/
public void setFillPattern(short fp)
@ -775,7 +775,7 @@ public class HSSFCellStyle
/**
* set the background fill color
* @param color
* @param bg color
*/
public void setFillBackgroundColor(short bg)
@ -795,7 +795,7 @@ public class HSSFCellStyle
/**
* set the foreground fill color
* @param color
* @param bg color
*/
public void setFillForegroundColor(short bg)

8
src/java/org/apache/poi/hssf/usermodel/HSSFRow.java
View File

@ -139,7 +139,7 @@ public class HSSFRow
*
* @param book low-level Workbook object containing the sheet that contains this row
* @param sheet low-level Sheet object that contains this Row
* @param RowRecord - the low level api object this row should represent
* @param record the low level api object this row should represent
* @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(short)
*/
@ -252,7 +252,7 @@ public class HSSFRow
/**
* set the row number of this row.
* @param row number the row number (0-based)
* @param rowNum the row number (0-based)
*/
public void setRowNum(short rowNum)
@ -414,7 +414,7 @@ public class HSSFRow
/**
* set the row's height or set to ff (-1) for undefined/default-height. Set the height in "twips" or
* 1/20th of a point.
* @param rowheight or 0xff for undefined (use sheet default)
* @param height rowheight or 0xff for undefined (use sheet default)
*/
public void setHeight(short height)
@ -427,7 +427,7 @@ public class HSSFRow
/**
* set the row's height in points.
* @param rowheight
* @param height row height in points
*/
public void setHeightInPoints(float height)

43
src/java/org/apache/poi/hssf/usermodel/HSSFSheet.java
View File

@ -149,7 +149,7 @@ public class HSSFSheet
while (row != null)
{
HSSFRow hrow = createRowFromRecord(row);
createRowFromRecord(row);
row = sheet.getNextRow();
}
@ -183,7 +183,7 @@ public class HSSFSheet
/**
* Create a new row within the sheet and return the high level representation
*
* @param row number
* @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)
@ -200,7 +200,7 @@ public class HSSFSheet
/**
* Used internally to create a high level Row object from a low level row object.
* USed when reading an existing file
* @param RowRecord low level record to represent as a high level Row and add to sheet
* @param row low level record to represent as a high level Row and add to sheet
* @return HSSFRow high level representation
*/
@ -215,7 +215,7 @@ public class HSSFSheet
/**
* Remove a row from this sheet. All cells contained in the row are removed as well
*
* @param HSSFRow representing a row to remove.
* @param row representing a row to remove.
*/
public void removeRow(HSSFRow row)
@ -303,7 +303,7 @@ public class HSSFSheet
/**
* Returns the logical row (not physical) 0-based. If you ask for a row that is not
* defined you get a null. This is to say row 4 represents the fifth row on a sheet.
* @param row to get
* @param rownum row to get
* @return HSSFRow representing the rownumber or null if its not defined on the sheet
*/
@ -345,10 +345,11 @@ public class HSSFSheet
}
/**
* Seems to be unused (gjs)
*
* used internally to add cells from a high level row to the low level model
* @param HSSFRow the row object to represent in low level RowRecord.
* @param row the row object to represent in low level RowRecord.
*/
private void addCellsFromRow(HSSFRow row)
{
Iterator iter = row.cellIterator();
@ -399,7 +400,7 @@ public class HSSFSheet
/**
* get the default row height for the sheet (if the rows do not define their own height) in
* twips (1/20 of a point)
* @param default row height
* @retun default row height
*/
public short getDefaultRowHeight()
@ -410,7 +411,7 @@ public class HSSFSheet
/**
* get the default row height for the sheet (if the rows do not define their own height) in
* points.
* @param default row height
* @return default row height in points
*/
public float getDefaultRowHeightInPoints()
@ -421,7 +422,7 @@ public class HSSFSheet
/**
* set the default column width for the sheet (if the columns do not define their own width) in
* characters
* @param default column width
* @param width default column width
*/
public void setDefaultColumnWidth(short width)
@ -432,7 +433,7 @@ public class HSSFSheet
/**
* set the default row height for the sheet (if the rows do not define their own height) in
* twips (1/20 of a point)
* @return default row height
* @param height default row height
*/
public void setDefaultRowHeight(short height)
@ -443,7 +444,7 @@ public class HSSFSheet
/**
* set the default row height for the sheet (if the rows do not define their own height) in
* points
* @return default row height
* @param height default row height
*/
public void setDefaultRowHeightInPoints(float height)
@ -463,7 +464,7 @@ public class HSSFSheet
/**
* set whether gridlines printed.
* @return false if not printed.
* @param value false if not printed.
*/
public void setGridsPrinted(boolean value)
@ -564,7 +565,7 @@ public class HSSFSheet
/**
* whether alternate expression evaluation is on
* @param alternative expression evaluation or not
* @param b alternative expression evaluation or not
*/
public void setAlternativeExpression(boolean b)
@ -577,7 +578,7 @@ public class HSSFSheet
/**
* whether alternative formula entry is on
* @param alternative formulas or not
* @param b alternative formulas or not
*/
public void setAlternativeFormula(boolean b)
@ -590,7 +591,7 @@ public class HSSFSheet
/**
* show automatic page breaks or not
* @param whether to show auto page breaks
* @param b whether to show auto page breaks
*/
public void setAutobreaks(boolean b)
@ -603,7 +604,7 @@ public class HSSFSheet
/**
* set whether sheet is a dialog sheet or not
* @param isDialog or not
* @param b isDialog or not
*/
public void setDialog(boolean b)
@ -617,7 +618,7 @@ public class HSSFSheet
/**
* set whether to display the guts or not
*
* @param guts or no guts (or glory)
* @param b guts or no guts (or glory)
*/
public void setDisplayGuts(boolean b)
@ -630,7 +631,7 @@ public class HSSFSheet
/**
* fit to page option is on
* @param fit or not
* @param b fit or not
*/
public void setFitToPage(boolean b)
@ -643,7 +644,7 @@ public class HSSFSheet
/**
* set if row summaries appear below detail in the outline
* @param below or not
* @param b below or not
*/
public void setRowSumsBelow(boolean b)
@ -656,7 +657,7 @@ public class HSSFSheet
/**
* set if col summaries appear right of the detail in the outline
* @param right or not
* @param b right or not
*/
public void setRowSumsRight(boolean b)

10
src/java/org/apache/poi/hssf/util/Region.java
View File

@ -146,7 +146,7 @@ public class Region
/**
* set the upper left hand corner column number
*
* @param column number for the upper left hand corner
* @param colFrom column number for the upper left hand corner
*/
public void setColumnFrom(short colFrom)
@ -157,7 +157,7 @@ public class Region
/**
* set the upper left hand corner row number
*
* @param row number for the upper left hand corner
* @param rowFrom row number for the upper left hand corner
*/
public void setRowFrom(int rowFrom)
@ -168,7 +168,7 @@ public class Region
/**
* set the lower right hand corner column number
*
* @param column number for the lower right hand corner
* @param colTo column number for the lower right hand corner
*/
public void setColumnTo(short colTo)
@ -179,7 +179,7 @@ public class Region
/**
* get the lower right hand corner row number
*
* @param row number for the lower right hand corner
* @param rowTo row number for the lower right hand corner
*/
public void setRowTo(int rowTo)
@ -217,7 +217,7 @@ public class Region
* coordinants then a positive integer is returned. Otherwise a negative
* integer is returned.
*
* @param region
* @param r region
* @see #compareTo(Object)
*/