From 8c4341facf8f9ea568cabab2c7dd68be657e3f6b Mon Sep 17 00:00:00 2001 From: Yegor Kozlov Date: Sun, 6 Jun 2010 18:19:08 +0000 Subject: [PATCH] cleaned javadoc warnings git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@951920 13f79535-47bb-0310-9956-ffa450edef68 --- .../poi/hssf/eventusermodel/HSSFEventFactory.java | 6 ++---- .../poi/hssf/eventusermodel/HSSFRequest.java | 1 - .../org/apache/poi/hssf/record/NameRecord.java | 2 +- .../apache/poi/hssf/record/RecordInputStream.java | 2 +- .../record/aggregates/SharedValueManager.java | 6 ------ .../poi/hssf/record/common/FeatFormulaErr2.java | 3 +-- .../poi/hssf/record/common/FeatProtection.java | 3 +-- .../poi/hssf/record/common/FeatSmartTag.java | 3 +-- .../record/formula/functions/TextFunction.java | 2 +- .../apache/poi/hssf/usermodel/HSSFDataFormat.java | 2 +- .../apache/poi/poifs/storage/RawDataBlock.java | 3 ++- .../org/apache/poi/ss/format/CellFormatter.java | 2 +- src/java/org/apache/poi/ss/formula/TwoDEval.java | 2 +- .../ss/formula/eval/forked/ForkedEvaluator.java | 4 +++- .../apache/poi/ss/usermodel/BuiltinFormats.java | 2 +- .../java/org/apache/poi/xssf/model/MapInfo.java | 4 ++-- .../java/org/apache/poi/xssf/model/Table.java | 15 +++++++-------- .../apache/poi/xwpf/usermodel/XWPFParagraph.java | 3 +-- .../src/org/apache/poi/hsmf/MAPIMessage.java | 5 +++-- .../org/apache/poi/hsmf/datatypes/ByteChunk.java | 2 +- .../hsmf/datatypes/MessageSubmissionChunk.java | 6 +++--- .../record/formula/functions/TestCountFuncs.java | 2 +- .../hssf/record/formula/functions/TestFind.java | 2 +- 23 files changed, 36 insertions(+), 46 deletions(-) diff --git a/src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java b/src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java index ede5612cb..3b064dc53 100644 --- a/src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java +++ b/src/java/org/apache/poi/hssf/eventusermodel/HSSFEventFactory.java @@ -34,8 +34,6 @@ import org.apache.poi.poifs.filesystem.POIFSFileSystem; * a static id matching one that you have registered in your HSSFRequest will be passed * to your associated HSSFListener. * - * @see org.apache.poi.hssf.dev.EFHSSF - * * @author Andrew C. Oliver (acoliver at apache dot org) * @author Carey Sublette (careysub@earthling.net) */ @@ -59,7 +57,7 @@ public class HSSFEventFactory { * Processes a file into essentially record events. * * @param req an Instance of HSSFRequest which has your registered listeners - * @param fs a POIFS filesystem containing your workbook + * @param dir a DirectoryNode containing your workbook */ public void processWorkbookEvents(HSSFRequest req, DirectoryNode dir) throws IOException { InputStream in = dir.createDocumentInputStream("Workbook"); @@ -83,7 +81,7 @@ public class HSSFEventFactory { * Processes a file into essentially record events. * * @param req an Instance of HSSFRequest which has your registered listeners - * @param fs a POIFS filesystem containing your workbook + * @param dir a DirectoryNode containing your workbook * @return numeric user-specified result code. */ public short abortableProcessWorkbookEvents(HSSFRequest req, DirectoryNode dir) diff --git a/src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java b/src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java index af23a2c49..dd30d4ddb 100644 --- a/src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java +++ b/src/java/org/apache/poi/hssf/eventusermodel/HSSFRequest.java @@ -31,7 +31,6 @@ import org.apache.poi.hssf.record.RecordFactory; * * @see org.apache.poi.hssf.eventusermodel.HSSFEventFactory * @see org.apache.poi.hssf.eventusermodel.HSSFListener - * @see org.apache.poi.hssf.dev.EFHSSF * @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/NameRecord.java b/src/java/org/apache/poi/hssf/record/NameRecord.java index 9084f1236..144a15e02 100644 --- a/src/java/org/apache/poi/hssf/record/NameRecord.java +++ b/src/java/org/apache/poi/hssf/record/NameRecord.java @@ -242,7 +242,7 @@ public final class NameRecord extends StandardRecord { * Indicates that the defined name refers to a user-defined function. * This attribute is used when there is an add-in or other code project associated with the file. * - * @param value true indicates the name refers to a function. + * @param function true indicates the name refers to a function. */ public void setFunction(boolean function){ if (function) { diff --git a/src/java/org/apache/poi/hssf/record/RecordInputStream.java b/src/java/org/apache/poi/hssf/record/RecordInputStream.java index c044dd779..6a49ad283 100644 --- a/src/java/org/apache/poi/hssf/record/RecordInputStream.java +++ b/src/java/org/apache/poi/hssf/record/RecordInputStream.java @@ -431,7 +431,7 @@ public final class RecordInputStream implements LittleEndianInput { } /** - @requrn sid of next record. Can be called after hasNextRecord() + @return sid of next record. Can be called after hasNextRecord() */ public int getNextSid() { return _nextSid; diff --git a/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java b/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java index 91c3e3b15..ff29dd1ab 100644 --- a/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java +++ b/src/java/org/apache/poi/hssf/record/aggregates/SharedValueManager.java @@ -154,12 +154,6 @@ public final class SharedValueManager { } /** - * @param firstCells - * @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 SharedFormulaRecords from any other - * sheet (which could happen if endIx is chosen poorly). (see bug 44449) */ public static SharedValueManager create(SharedFormulaRecord[] sharedFormulaRecords, CellReference[] firstCells, ArrayRecord[] arrayRecords, TableRecord[] tableRecords) { diff --git a/src/java/org/apache/poi/hssf/record/common/FeatFormulaErr2.java b/src/java/org/apache/poi/hssf/record/common/FeatFormulaErr2.java index adf1b888a..b3a9a96ad 100644 --- a/src/java/org/apache/poi/hssf/record/common/FeatFormulaErr2.java +++ b/src/java/org/apache/poi/hssf/record/common/FeatFormulaErr2.java @@ -30,8 +30,7 @@ import org.apache.poi.util.LittleEndianOutput; *

* This record part specifies Formula Evaluation & Error Ignoring data * for a sheet, stored as part of a Shared Feature. It can be found in - * records such as {@link FeatRecord}, {@link Feat11Record} or - * {@link Feat12Record}. + * records such as {@link FeatRecord}. * For the full meanings of the flags, see pages 669 and 670 * of the Excel binary file format documentation. */ diff --git a/src/java/org/apache/poi/hssf/record/common/FeatProtection.java b/src/java/org/apache/poi/hssf/record/common/FeatProtection.java index bab65e621..a10d7119c 100644 --- a/src/java/org/apache/poi/hssf/record/common/FeatProtection.java +++ b/src/java/org/apache/poi/hssf/record/common/FeatProtection.java @@ -31,8 +31,7 @@ import org.apache.poi.util.StringUtil; *

* This record part specifies Protection data for a sheet, stored * as part of a Shared Feature. It can be found in records such - * as {@link FeatRecord}, {@link Feat11Record} or - * {@link Feat12Record} + * as {@link FeatRecord} */ public final class FeatProtection implements SharedFeature { public static long NO_SELF_RELATIVE_SECURITY_FEATURE = 0; diff --git a/src/java/org/apache/poi/hssf/record/common/FeatSmartTag.java b/src/java/org/apache/poi/hssf/record/common/FeatSmartTag.java index 2fc53e24f..f2e9cc69f 100644 --- a/src/java/org/apache/poi/hssf/record/common/FeatSmartTag.java +++ b/src/java/org/apache/poi/hssf/record/common/FeatSmartTag.java @@ -27,8 +27,7 @@ import org.apache.poi.util.LittleEndianOutput; * Title: FeatSmartTag (Smart Tag Shared Feature) common record part *

* This record part specifies Smart Tag data for a sheet, stored as part - * of a Shared Feature. It can be found in records such as - * {@link FeatRecord}, {@link Feat11Record} or {@link Feat12Record}. + * of a Shared Feature. It can be found in records such as {@link FeatRecord}. * It is made up of a hash, and a set of Factoid Data that makes up * the smart tags. * For more details, see page 669 of the Excel binary file diff --git a/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java b/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java index 3e43ac28f..6e7e83a8c 100644 --- a/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java +++ b/src/java/org/apache/poi/hssf/record/formula/functions/TextFunction.java @@ -353,7 +353,7 @@ public abstract class TextFunction implements Function { * start_num, is optional (default=1) and specifies where to start searching * from. Character positions are 1-based.

* - * @author Torstein Tauno Svendsen (torstei@officenet.no) + * Author: Torstein Tauno Svendsen (torstei@officenet.no) */ public static final Function FIND = new SearchFind(true); /** diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFDataFormat.java b/src/java/org/apache/poi/hssf/usermodel/HSSFDataFormat.java index f18f37738..beb22a2a4 100644 --- a/src/java/org/apache/poi/hssf/usermodel/HSSFDataFormat.java +++ b/src/java/org/apache/poi/hssf/usermodel/HSSFDataFormat.java @@ -96,7 +96,7 @@ public final class HSSFDataFormat implements DataFormat { * Get the format index that matches the given format * string, creating a new format entry if required. * Aliases text to the proper format as required. - * @param format string matching a built in format + * @param pFormat string matching a built in format * @return index of format. */ public short getFormat(String pFormat) { diff --git a/src/java/org/apache/poi/poifs/storage/RawDataBlock.java b/src/java/org/apache/poi/poifs/storage/RawDataBlock.java index 07832db26..018ee8ff2 100644 --- a/src/java/org/apache/poi/poifs/storage/RawDataBlock.java +++ b/src/java/org/apache/poi/poifs/storage/RawDataBlock.java @@ -57,7 +57,8 @@ public class RawDataBlock * Constructor RawDataBlock * * @param stream the InputStream from which the data will be read - * @param blockSize the size of the POIFS blocks, normally 512 bytes {@link POIFSConstants#BIG_BLOCK_SIZE} + * @param blockSize the size of the POIFS blocks, normally 512 bytes + * {@link org.apache.poi.poifs.common.POIFSConstants#SMALLER_BIG_BLOCK_SIZE} * * @exception IOException on I/O errors, and if an insufficient * amount of data is read (the InputStream must diff --git a/src/java/org/apache/poi/ss/format/CellFormatter.java b/src/java/org/apache/poi/ss/format/CellFormatter.java index a12518120..23cfbe541 100644 --- a/src/java/org/apache/poi/ss/format/CellFormatter.java +++ b/src/java/org/apache/poi/ss/format/CellFormatter.java @@ -22,7 +22,7 @@ import java.util.logging.Logger; /** * This is the abstract supertype for the various cell formatters. * - * @@author Ken Arnold, Industrious Media LLC + * @author Ken Arnold, Industrious Media LLC */ public abstract class CellFormatter { /** The original specified format. */ diff --git a/src/java/org/apache/poi/ss/formula/TwoDEval.java b/src/java/org/apache/poi/ss/formula/TwoDEval.java index ff3b933f9..fbb24e8dd 100644 --- a/src/java/org/apache/poi/ss/formula/TwoDEval.java +++ b/src/java/org/apache/poi/ss/formula/TwoDEval.java @@ -21,7 +21,7 @@ import org.apache.poi.hssf.record.formula.eval.AreaEval; import org.apache.poi.hssf.record.formula.eval.ValueEval; /** - * Common interface of {@link AreaEval} and {@link ArrayEval} + * Common interface of {@link AreaEval} and {@link org.apache.poi.hssf.record.formula.eval.AreaEvalBase} * * @author Josh Micich */ diff --git a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java index 798560374..258a5166f 100644 --- a/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java +++ b/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluator.java @@ -104,7 +104,9 @@ public final class ForkedEvaluator { * evaluateInCell() when the call should not modify the contents of the * original cell. * - * @param cell may be null signifying that the cell is not present (or blank) + * @param sheetName the name of the sheet containing the cell + * @param rowIndex zero based + * @param columnIndex zero based * @return null if the supplied cell is null or blank */ public ValueEval evaluate(String sheetName, int rowIndex, int columnIndex) { diff --git a/src/java/org/apache/poi/ss/usermodel/BuiltinFormats.java b/src/java/org/apache/poi/ss/usermodel/BuiltinFormats.java index e9eebaff4..a63bff366 100644 --- a/src/java/org/apache/poi/ss/usermodel/BuiltinFormats.java +++ b/src/java/org/apache/poi/ss/usermodel/BuiltinFormats.java @@ -172,7 +172,7 @@ public final class BuiltinFormats { *

* Automatically converts "text" to excel's format string to represent text. *

- * @param fmt string matching a built-in format + * @param pFmt string matching a built-in format * @return index of format or -1 if undefined. */ public static int getBuiltinFormat(String pFmt) { diff --git a/src/ooxml/java/org/apache/poi/xssf/model/MapInfo.java b/src/ooxml/java/org/apache/poi/xssf/model/MapInfo.java index f1243d3e1..eb66c7df9 100644 --- a/src/ooxml/java/org/apache/poi/xssf/model/MapInfo.java +++ b/src/ooxml/java/org/apache/poi/xssf/model/MapInfo.java @@ -100,9 +100,9 @@ public class MapInfo extends POIXMLDocumentPart { } /** - * Gets the CTSchema buy it's ID + * Gets the * @param schemaId the schema ID - * @return + * @return CTSchema by it's ID */ public CTSchema getCTSchemaById(String schemaId){ CTSchema xmlSchema = null; diff --git a/src/ooxml/java/org/apache/poi/xssf/model/Table.java b/src/ooxml/java/org/apache/poi/xssf/model/Table.java index 9ab24ac57..eddff2296 100644 --- a/src/ooxml/java/org/apache/poi/xssf/model/Table.java +++ b/src/ooxml/java/org/apache/poi/xssf/model/Table.java @@ -187,8 +187,7 @@ public class Table extends POIXMLDocumentPart { } /** - * the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4) - * @return + * @return the number of mapped table columns (see Open Office XML Part 4: chapter 3.5.1.4) */ public long getNumerOfMappedColumns(){ return ctTable.getTableColumns().getCount(); @@ -196,9 +195,9 @@ public class Table extends POIXMLDocumentPart { /** - * The reference for the cell in the top-left part of the table + * @return The reference for the cell in the top-left part of the table * (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref) - * @return + * */ public CellReference getStartCellReference() { @@ -212,9 +211,9 @@ public class Table extends POIXMLDocumentPart { } /** - * The reference for the cell in the bottom-right part of the table + * @return The reference for the cell in the bottom-right part of the table * (see Open Office XML Part 4: chapter 3.5.1.2, attribute ref) - * @return + * */ public CellReference getEndCellReference() { @@ -230,8 +229,8 @@ public class Table extends POIXMLDocumentPart { /** - * Gets the total number of rows in the selection. (Note: in this version autofiltering is ignored) - * @return + * @return the total number of rows in the selection. (Note: in this version autofiltering is ignored) + * */ public int getRowCount(){ diff --git a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java index b09cc1edd..bf8202dad 100644 --- a/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java +++ b/src/ooxml/java/org/apache/poi/xwpf/usermodel/XWPFParagraph.java @@ -987,8 +987,7 @@ public class XWPFParagraph { } /** - * Gets the style of the paragraph - * @return + * @return the style of the paragraph */ public String getStyle() { CTPPr pr = getCTPPr(); diff --git a/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java b/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java index 9b2ccd765..8d84b1627 100644 --- a/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java +++ b/src/scratchpad/src/org/apache/poi/hsmf/MAPIMessage.java @@ -85,7 +85,7 @@ public class MAPIMessage extends POIDocument { } /** * Constructor for reading MSG Files from a POIFS filesystem - * @param in + * @param fs * @throws IOException */ public MAPIMessage(POIFSFileSystem fs) throws IOException { @@ -94,7 +94,8 @@ public class MAPIMessage extends POIDocument { /** * Constructor for reading MSG Files from a certain * point within a POIFS filesystem - * @param in + * @param poifsDir + * @param fs * @throws IOException */ public MAPIMessage(DirectoryNode poifsDir, POIFSFileSystem fs) throws IOException { diff --git a/src/scratchpad/src/org/apache/poi/hsmf/datatypes/ByteChunk.java b/src/scratchpad/src/org/apache/poi/hsmf/datatypes/ByteChunk.java index 2f430ed54..fc84d3731 100644 --- a/src/scratchpad/src/org/apache/poi/hsmf/datatypes/ByteChunk.java +++ b/src/scratchpad/src/org/apache/poi/hsmf/datatypes/ByteChunk.java @@ -68,7 +68,7 @@ public class ByteChunk extends Chunk { * If your data isn't in fact stored as basically * ASCII, don't expect this to return much of any * sense.... - * @return + * @return the data formatted as a string */ public String getAs7bitString() { return StringChunk.parseAs7BitData(value); diff --git a/src/scratchpad/src/org/apache/poi/hsmf/datatypes/MessageSubmissionChunk.java b/src/scratchpad/src/org/apache/poi/hsmf/datatypes/MessageSubmissionChunk.java index 7ca6fee3f..902549c1f 100644 --- a/src/scratchpad/src/org/apache/poi/hsmf/datatypes/MessageSubmissionChunk.java +++ b/src/scratchpad/src/org/apache/poi/hsmf/datatypes/MessageSubmissionChunk.java @@ -103,16 +103,16 @@ public class MessageSubmissionChunk extends Chunk { } /** - * Returns the date that the server accepted the + * @return the date that the server accepted the * message, as found from the message ID it generated. - * @return + * */ public Calendar getAcceptedAtTime() { return date; } /** - * Returns the full ID that the server generated when + * @return the full ID that the server generated when * it accepted the message. */ public String getSubmissionId() { diff --git a/src/testcases/org/apache/poi/hssf/record/formula/functions/TestCountFuncs.java b/src/testcases/org/apache/poi/hssf/record/formula/functions/TestCountFuncs.java index 08056cd03..bb3cfabe1 100644 --- a/src/testcases/org/apache/poi/hssf/record/formula/functions/TestCountFuncs.java +++ b/src/testcases/org/apache/poi/hssf/record/formula/functions/TestCountFuncs.java @@ -236,7 +236,7 @@ public final class TestCountFuncs extends TestCase { } /** - * the criteria arg is mostly handled by {@link OperandResolver#getSingleValue(Eval, int, short)} + * the criteria arg is mostly handled by {@link OperandResolver#getSingleValue(org.apache.poi.hssf.record.formula.eval.ValueEval, int, int)}} */ public void testCountifAreaCriteria() { int srcColIx = 2; // anything but column A diff --git a/src/testcases/org/apache/poi/hssf/record/formula/functions/TestFind.java b/src/testcases/org/apache/poi/hssf/record/formula/functions/TestFind.java index 3a6df7354..8fb3b2ba9 100644 --- a/src/testcases/org/apache/poi/hssf/record/formula/functions/TestFind.java +++ b/src/testcases/org/apache/poi/hssf/record/formula/functions/TestFind.java @@ -26,7 +26,7 @@ import org.apache.poi.hssf.usermodel.HSSFWorkbook; import org.apache.poi.ss.usermodel.CellValue; /** - * Tests for {@link Find} + * Tests for {@link Financed} * * @author Torstein Svendsen (torstei@officenet.no) */