From: Rainer Klute Date: Sat, 6 Dec 2003 11:01:19 +0000 (+0000) Subject: More Javadoc issues fixed. "ant javadoc" now runs without any complaints. However... X-Git-Tag: PERF_BEFORE_MERGE~70 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=0847bedae85b34b89eb858b1f69067c313b17ca9;p=poi.git 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 --- diff --git a/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java b/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java index a5259910a4..d17acc4507 100644 --- a/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java +++ b/src/contrib/src/org/apache/poi/hssf/contrib/view/SVTableUtils.java @@ -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; diff --git a/src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java b/src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java index 697df33d38..63d28dad3f 100644 --- a/src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java +++ b/src/java/org/apache/poi/hssf/eventusermodel/AbortableHSSFListener.java @@ -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) * diff --git a/src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java b/src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java index eef1d0a697..5ecc4ddeaa 100644 --- a/src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java +++ b/src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java @@ -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) */ diff --git a/src/java/org/apache/poi/hssf/record/BOFRecord.java b/src/java/org/apache/poi/hssf/record/BOFRecord.java index a44cc08339..54a5ddb629 100644 --- a/src/java/org/apache/poi/hssf/record/BOFRecord.java +++ b/src/java/org/apache/poi/hssf/record/BOFRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/CodepageRecord.java b/src/java/org/apache/poi/hssf/record/CodepageRecord.java index ab6a21ed7c..dc1c4aae9f 100644 --- a/src/java/org/apache/poi/hssf/record/CodepageRecord.java +++ b/src/java/org/apache/poi/hssf/record/CodepageRecord.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java b/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java index fad8f73345..4d4f95eaba 100644 --- a/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java +++ b/src/java/org/apache/poi/hssf/record/ExtendedFormatRecord.java @@ -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) */ diff --git a/src/java/org/apache/poi/hssf/record/PaletteRecord.java b/src/java/org/apache/poi/hssf/record/PaletteRecord.java index e538511217..f1d6d08a5f 100644 --- a/src/java/org/apache/poi/hssf/record/PaletteRecord.java +++ b/src/java/org/apache/poi/hssf/record/PaletteRecord.java @@ -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) { diff --git a/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java b/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java index 89401a981d..34e056dfac 100644 --- a/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/Area3DPtg.java @@ -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 ) { diff --git a/src/java/org/apache/poi/hssf/record/formula/AreaPtg.java b/src/java/org/apache/poi/hssf/record/formula/AreaPtg.java index 3189a2c856..02c63ea1c9 100644 --- a/src/java/org/apache/poi/hssf/record/formula/AreaPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/AreaPtg.java @@ -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); diff --git a/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java b/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java index 04fbcac2ef..9b87e68331 100644 --- a/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/GreaterThanPtg.java @@ -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; } /** diff --git a/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java b/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java index a856b93bde..6b66ea732b 100644 --- a/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java +++ b/src/java/org/apache/poi/hssf/record/formula/LessThanPtg.java @@ -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; } /** diff --git a/src/java/org/apache/poi/hssf/record/formula/Ptg.java b/src/java/org/apache/poi/hssf/record/formula/Ptg.java index cdf584ed1a..4b00c8e415 100644 --- a/src/java/org/apache/poi/hssf/record/formula/Ptg.java +++ b/src/java/org/apache/poi/hssf/record/formula/Ptg.java @@ -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(); diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java b/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java index 8a269543d9..016c0d42f1 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFFont.java @@ -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 diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFName.java b/src/java/org/apache/poi/hssf/usermodel/HSSFName.java index 8c18634025..0d1a87453d 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFName.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFName.java @@ -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; diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java index 962a0e6e35..c51f27abb3 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFRow.java @@ -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) diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java index e3fd336168..02bdc81167 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFWorkbook.java @@ -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) diff --git a/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java b/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java index ed6e9e5f7b..e4a560b590 100644 --- a/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java +++ b/src/java/org/apache/poi/poifs/filesystem/POIFSDocumentPath.java @@ -263,10 +263,9 @@ public class POIFSDocumentPath *

Returns the path's parent or null if this path * is the root path.

* - * @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 *

Returns a string representation of the path. Components are * separated by the platform-specific file separator.

* - * @author Rainer Klute (klute@rainer-klute.de) - * @since 2002-01-24 - * * @return string representation + * + * @since 2002-01-24 */ public String toString() diff --git a/src/java/org/apache/poi/poifs/storage/BlockAllocationTableWriter.java b/src/java/org/apache/poi/poifs/storage/BlockAllocationTableWriter.java index 001b67f8ce..df584470fb 100644 --- a/src/java/org/apache/poi/poifs/storage/BlockAllocationTableWriter.java +++ b/src/java/org/apache/poi/poifs/storage/BlockAllocationTableWriter.java @@ -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 */ diff --git a/src/java/org/apache/poi/poifs/storage/SmallBlockTableWriter.java b/src/java/org/apache/poi/poifs/storage/SmallBlockTableWriter.java index 5bd06bf927..3d9420fd82 100644 --- a/src/java/org/apache/poi/poifs/storage/SmallBlockTableWriter.java +++ b/src/java/org/apache/poi/poifs/storage/SmallBlockTableWriter.java @@ -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 */ diff --git a/src/java/org/apache/poi/util/CommonsLogger.java b/src/java/org/apache/poi/util/CommonsLogger.java index f82f4d7687..ab0943e2ae 100644 --- a/src/java/org/apache/poi/util/CommonsLogger.java +++ b/src/java/org/apache/poi/util/CommonsLogger.java @@ -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) diff --git a/src/java/org/apache/poi/util/NullLogger.java b/src/java/org/apache/poi/util/NullLogger.java index fa372ebbce..163490cb12 100644 --- a/src/java/org/apache/poi/util/NullLogger.java +++ b/src/java/org/apache/poi/util/NullLogger.java @@ -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) diff --git a/src/java/org/apache/poi/util/POILogger.java b/src/java/org/apache/poi/util/POILogger.java index c3dce69cab..023dd52e58 100644 --- a/src/java/org/apache/poi/util/POILogger.java +++ b/src/java/org/apache/poi/util/POILogger.java @@ -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); diff --git a/src/java/org/apache/poi/util/StringUtil.java b/src/java/org/apache/poi/util/StringUtil.java index c856b0181d..e883e3d12b 100644 --- a/src/java/org/apache/poi/util/StringUtil.java +++ b/src/java/org/apache/poi/util/StringUtil.java @@ -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, diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/CHPFormattedDiskPage.java b/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/CHPFormattedDiskPage.java index 5a5d9e4907..39beb5918e 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/CHPFormattedDiskPage.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/CHPFormattedDiskPage.java @@ -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) { diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/PAPFormattedDiskPage.java b/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/PAPFormattedDiskPage.java index f9ca0e3901..4c6ebb9c91 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/PAPFormattedDiskPage.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/PAPFormattedDiskPage.java @@ -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) { diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/PropertyNode.java b/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/PropertyNode.java index 8ff76816da..972ea9c3cc 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/PropertyNode.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/PropertyNode.java @@ -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() { diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/StyleSheet.java b/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/StyleSheet.java index 2d597180f4..68a117bf07 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/StyleSheet.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/StyleSheet.java @@ -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) { diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/TextPiece.java b/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/TextPiece.java index 4c9db04671..4065a86dad 100644 --- a/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/TextPiece.java +++ b/src/scratchpad/src/org/apache/poi/hwpf/model/hdftypes/TextPiece.java @@ -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