Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More Javadoc issues fixed. "ant javadoc" now runs without any complaints. However, this does not mean the the documentation is fine. Please check your documentation! 

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353467 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Rainer Klute 2003-12-06 11:01:19 +00:00
parent 922de80904
commit 0847bedae8
28 changed files with 41 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java
View File

@ -79,10 +79,6 @@ public class SVTableUtils {
/**
* Creates a new font for a specific cell style
*
* @param wb Description of the Parameter
* @param style Description of the Parameter
* @return Description of the Return Value
*/
public static Font makeFont(HSSFFont font) {
boolean isbold = font.getBoldweight() > HSSFFont.BOLDWEIGHT_NORMAL;

6
src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java
View File

@ -63,9 +63,9 @@ import org.apache.poi.hssf.eventusermodel.HSSFUserException;
* a listener supporting this interface and register it with the HSSFRequest (associating
* it with Record SID's).
*
* @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
* @see org.apache.poi.hssf.eventusermodel.HSSFRequest
* @see org.apache.poi.hssf.HSSFUserException
* @see HSSFEventFactory
* @see HSSFRequest
* @see AbortableHSSFListener
*
* @author Carey Sublette (careysub@earthling.net)
*

6
src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java
View File

@ -66,10 +66,10 @@ import org.apache.poi.hssf.record.RecordFactory;
* An HSSFRequest object should be constructed registering an instance or multiple
* instances of HSSFListener with each Record.sid you wish to listen for.
*
* @see org.apache.poi.hssf.eventmodel.HSSFEventFactory
* @see org.apache.poi.hssf.eventmodel.HSSFListener
* @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory
* @see org.apache.poi.hssf.eventusermodel.HSSFRequest
* @see org.apache.poi.hssf.dev.EFHSSF
* @see org.apache.poi.hssf.HSSFUserException
* @see org.apache.poi.hssf.eventusermodel.HSSFUserException
* @author Andrew C. Oliver (acoliver at apache dot org)
* @author Carey Sublette (careysub@earthling.net)
*/

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

@ -212,7 +212,7 @@ public class BOFRecord
/**
* Year of the build that wrote this file
* @see #BUILD_YEAR
* @param build year to set
* @param year year to set
*/
public void setBuildYear(short year)

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

@ -127,7 +127,7 @@ public class CodepageRecord
* set the codepage for this workbook
*
* @see #CODEPAGE
* @param the codepage to set
* @param cp the codepage to set
*/
public void setCodepage(short cp)

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

@ -641,8 +641,8 @@ public class ExtendedFormatRecord
* set whether or not to use the pattern in this XF instead of the parent XF.
* (foregrount/background)
*
* @param pattern- true if this XF has a different pattern value than its parent,
* false otherwise.
* @param pattern true if this XF has a different pattern value than its parent,
* false otherwise.
* @see #setIndentionOptions(short)
*/
@ -657,8 +657,8 @@ public class ExtendedFormatRecord
* set whether or not to use the locking/hidden in this XF instead of the parent XF.
*
*
* @param options- true if this XF has a different locking or hidden value than its parent,
* false otherwise.
* @param options true if this XF has a different locking or hidden value than its parent,
* false otherwise.
* @see #setIndentionOptions(short)
*/

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

@ -205,8 +205,8 @@ public class PaletteRecord
* If the given index is greater than the current last color index,
* then black is inserted at every index required to make the palette continuous.
*
* @param i the index to set; if this index is less than 0x8 or greater than
* 0x40, then no modification is made
* @param byteIndex the index to set; if this index is less than 0x8 or
* greater than 0x40, then no modification is made
*/
public void setColor(short byteIndex, byte red, byte green, byte blue)
{

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

@ -236,7 +236,7 @@ public class Area3DPtg extends Ptg
/**
* sets the first row to relative or not
* @param isRelative or not.
* @param rel specifies whether the first row is relative or not
*/
public void setFirstRowRelative( boolean rel )
{
@ -253,7 +253,7 @@ public class Area3DPtg extends Ptg
/**
* set whether the last row is relative or not
* @param last row relative
* @param rel specifies whether the last row is relative
*/
public void setLastRowRelative( boolean rel )
{

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

@ -171,7 +171,7 @@ public class AreaPtg
}
/**
* @param last row number in the area
* @param row last row number in the area
*/
public void setLastRow(short row)
{
@ -267,7 +267,7 @@ public class AreaPtg
/**
* set whether the last row is relative or not
* @param last row relative
* @param rel specifies whether the last row is relative or not
*/
public void setLastRowRelative(boolean rel) {
field_4_last_column=rowRelative.setShortBoolean(field_4_last_column,rel);

3
src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java
View File

@ -131,11 +131,10 @@ public class GreaterThanPtg
/**
* Implementation of method from Ptg
* @param refs the Sheet References
*/
public String toFormulaString(Workbook book)
{
return this.GREATERTHAN;
return GreaterThanPtg.GREATERTHAN;
}
/**

3
src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java
View File

@ -140,11 +140,10 @@ public class LessThanPtg
/**
* Implementation of method from Ptg
* @param refs the Sheet References
*/
public String toFormulaString(Workbook book)
{
return this.LESSTHAN;
return LessThanPtg.LESSTHAN;
}
/**

10
src/java/org/apache/poi/hssf/record/formula/Ptg.java
View File

@ -75,16 +75,16 @@ import org.apache.poi.hssf.model.Workbook;
public abstract class Ptg
{
/** convert infix order ptg list to rpn order ptg list
* @return List ptgs in RPN order
* @param infixPtgs List of ptgs in infix order
*/
/* DO NOT REMOVE
*we keep this method in case we wish to change the way we parse
*It needs a getPrecedence in OperationsPtg
/** convert infix order ptg list to rpn order ptg list
* @return List ptgs in RPN order
* @param infixPtgs List of ptgs in infix order
*/
/*
public static List ptgsToRpn(List infixPtgs) {
java.util.Stack operands = new java.util.Stack();
java.util.List retval = new java.util.Stack();

6
src/java/org/apache/poi/hssf/usermodel/HSSFFont.java
View File

@ -165,7 +165,7 @@ public class HSSFFont
/**
* set the name for the font (i.e. Arial)
* @param String representing the name of the font to use
* @param name the name of the font to use
* @see #FONT_ARIAL
*/
@ -245,7 +245,7 @@ public class HSSFFont
/**
* set whether to use italics or not
* @param italics or not
* @param italic use italics or not
*/
public void setItalic(boolean italic)
@ -359,7 +359,7 @@ public class HSSFFont
/**
* set type of text underlining to use
* @param underlining type
* @param underline the underlining type to use
* @see #U_NONE
* @see #U_SINGLE
* @see #U_DOUBLE

4
src/java/org/apache/poi/hssf/usermodel/HSSFName.java
View File

@ -74,8 +74,8 @@ public class HSSFName {
*
* @see org.apache.poi.hssf.usermodel.HSSFWorkbook#createName()
* @param name the Name Record
* @param book - lowlevel Workbook object associated with the sheet.
* @param book the Workbook */
* @param book lowlevel Workbook object associated with the sheet.
*/
protected HSSFName(Workbook book, NameRecord name) {
this.book = book;

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

@ -117,7 +117,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 rowNum the row number of this row (0 based)
* @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(short)
* @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(int)
*/
//protected HSSFRow(Workbook book, Sheet sheet, short rowNum)
@ -143,7 +143,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 record the low level api object this row should represent
* @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(short)
* @see org.apache.poi.hssf.usermodel.HSSFSheet#createRow(int)
*/
protected HSSFRow(Workbook book, Sheet sheet, RowRecord record)

4
src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java
View File

@ -273,8 +273,8 @@ public class HSSFWorkbook
* set the sheet name.
* Will throw IllegalArgumentException if the name is greater than 31 chars
* or contains /\?*[]
* @param sheet number (0 based)
* @param sheet name
* @param sheet sheet number (0 based)
* @param name sheet name
*/
public void setSheetName(int sheet, String name)

10
src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java
View File

@ -263,10 +263,9 @@ public class POIFSDocumentPath
* <p>Returns the path's parent or <code>null</code> if this path
* is the root path.</p>
*
* @author Rainer Klute (klute@rainer-klute.de)
* @since 2002-01-24
*
* @return path of parent, or null if this path is the root path
*
* @since 2002-01-24
*/
public POIFSDocumentPath getParent()
@ -288,10 +287,9 @@ public class POIFSDocumentPath
* <p>Returns a string representation of the path. Components are
* separated by the platform-specific file separator.</p>
*
* @author Rainer Klute (klute@rainer-klute.de)
* @since 2002-01-24
*
* @return string representation
*
* @since 2002-01-24
*/
public String toString()

3
src/java/org/apache/poi/poifs/storage/BlockAllocationTableWriter.java
View File

@ -225,9 +225,6 @@ public class BlockAllocationTableWriter
/**
* Set the start block for this instance
*
* @param index index into the array of BigBlock instances making
* up the the filesystem
*
* @param start_block
*/

3
src/java/org/apache/poi/poifs/storage/SmallBlockTableWriter.java
View File

@ -150,9 +150,6 @@ public class SmallBlockTableWriter
/**
* Set the start block for this instance
*
* @param index index into the array of BigBlock instances making
* up the the filesystem
*
* @param start_block
*/

1
src/java/org/apache/poi/util/CommonsLogger.java
View File

@ -141,7 +141,6 @@ public class CommonsLogger extends POILogger
* Check if a logger is enabled to log at the specified level
*
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
* @param obj1 The logger to check.
*/
public boolean check(final int level)

1
src/java/org/apache/poi/util/NullLogger.java
View File

@ -91,7 +91,6 @@ public class NullLogger extends POILogger
* Check if a logger is enabled to log at the specified level
*
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
* @param obj1 The logger to check.
*/
public boolean check(final int level)

1
src/java/org/apache/poi/util/POILogger.java
View File

@ -94,7 +94,6 @@ public abstract class POILogger
* Check if a logger is enabled to log at the specified level
*
* @param level One of DEBUG, INFO, WARN, ERROR, FATAL
* @param obj1 The logger to check.
*/
abstract public boolean check(final int level);

6
src/java/org/apache/poi/util/StringUtil.java
View File

@ -86,7 +86,7 @@ public class StringUtil {
*@param offset the initial offset into the
* byte array. it is assumed that string[ offset ] and string[ offset +
* 1 ] contain the first 16-bit unicode character
*@param len
*@param len the length of the final string
*@return the converted string
*@exception ArrayIndexOutOfBoundsException if offset is out of bounds for
* the byte array (i.e., is negative or is greater than or equal to
@ -94,7 +94,6 @@ public class StringUtil {
*@exception IllegalArgumentException if len is too large (i.e.,
* there is not enough data in string to create a String of that
* length)
*@param len the length of the final string
*/
public static String getFromUnicodeLE(
final byte[] string,
@ -138,7 +137,7 @@ public class StringUtil {
**@param offset the initial offset into the
* byte array. it is assumed that string[ offset ] and string[ offset +
* 1 ] contain the first 16-bit unicode character
*@param len
*@param len the length of the final string
*@return the converted string
*@exception ArrayIndexOutOfBoundsException if offset is out of bounds for
* the byte array (i.e., is negative or is greater than or equal to
@ -146,7 +145,6 @@ public class StringUtil {
*@exception IllegalArgumentException if len is too large (i.e.,
* there is not enough data in string to create a String of that
* length)
*@param len the length of the final string
*/
public static String getFromUnicodeBE(
final byte[] string,

2
src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/CHPFormattedDiskPage.java
View File

@ -89,8 +89,6 @@ public class CHPFormattedDiskPage extends FormattedDiskPage
/**
* This constructs a CHPFormattedDiskPage from a raw fkp (512 byte array
* read from a Word file).
*
* @param fkp The 512 byte array to read data from
*/
public CHPFormattedDiskPage(byte[] documentStream, int offset, int fcMin)
{

2
src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/PAPFormattedDiskPage.java
View File

@ -93,8 +93,6 @@ public class PAPFormattedDiskPage extends FormattedDiskPage
/**
* Creates a PAPFormattedDiskPage from a 512 byte array
*
* @param fkp a 512 byte array.
*/
public PAPFormattedDiskPage(byte[] documentStream, int offset, int fcMin)
{

3
src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/PropertyNode.java
View File

@ -74,7 +74,6 @@ public class PropertyNode implements Comparable
/**
* @param fcStart The start of the text for this property.
* @param fcEnd The end of the text for this property.
* @param grpprl The property description in compressed form.
*/
public PropertyNode(int fcStart, int fcEnd, Object buf)
{
@ -97,7 +96,7 @@ public class PropertyNode implements Comparable
}
/**
* @retrun The offset of the end of this property's text.
* @return The offset of the end of this property's text.
*/
public int getEnd()
{

4
src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/StyleSheet.java
View File

@ -98,10 +98,6 @@ public class StyleSheet implements HDFType
/**
* StyleSheet constructor. Loads a document's stylesheet information,
*
* @param styleSheet A byte array containing a document's raw stylesheet
* info. Found by using FileInformationBlock.getFcStshf() and
* FileInformationBLock.getLcbStshf()
*/
public StyleSheet(byte[] tableStream, int offset)
{

3
src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/TextPiece.java
View File

@ -70,9 +70,6 @@ public class TextPiece extends PropertyNode implements Comparable
/**
* @param start Offset in main document stream.
* @param length The total length of the text in bytes. Note: 1 character
* does not necessarily refer to 1 byte.
* @param unicode true if this text is unicode.
*/
public TextPiece(int start, int end, byte[] text, PieceDescriptor pd)
throws UnsupportedEncodingException