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

Some more fixes for javadoc warnings

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@551908 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2007-06-29 14:18:11 +00:00
parent 4461ddc84e
commit aaf2c3119e
22 changed files with 0 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/java/org/apache/poi/hssf/model/FormulaParser.java
View File

@ -534,7 +534,6 @@ public class FormulaParser {
/** Get a PTG for an integer from its string representation.
* return Int or Number Ptg based on size of input
* @param number
* @return
*/
private Ptg getNumberPtgFromString(String number) {
try {

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

@ -2506,7 +2506,6 @@ public class Sheet implements Model
/** Returns the ProtectRecord.
* If one is not contained in the sheet, then one is created.
* @return
*/
public ProtectRecord getProtect()
{

1
src/java/org/apache/poi/hssf/model/SimpleFilledShape.java
View File

@ -48,7 +48,6 @@ public class SimpleFilledShape
*
* @param hssfShape
* @param shapeId
* @return
*/
private EscherContainerRecord createSpContainer( HSSFSimpleShape hssfShape, int shapeId )
{

1
src/java/org/apache/poi/hssf/model/TextboxShape.java
View File

@ -77,7 +77,6 @@ public class TextboxShape
*
* @param hssfShape
* @param shapeId
* @return
*/
private EscherContainerRecord createSpContainer( HSSFTextbox hssfShape, int shapeId )
{

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

@ -343,7 +343,6 @@ public class HSSFWorkbook
* allow you to show the data of one sheet when another is seen "selected"
* in the tabs (at the bottom).
* @see org.apache.poi.hssf.usermodel.HSSFSheet#setSelected(boolean)
* @return
*/
public short getSelectedTab() {
return workbook.getWindowOne().getSelectedTab();
@ -361,7 +360,6 @@ public class HSSFWorkbook
/**
* sets the first tab that is displayed in the list of tabs
* in excel.
* @return
*/
public short getDisplayedTab() {
return workbook.getWindowOne().getDisplayedTab();

1
src/scratchpad/src/org/apache/poi/hdgf/chunks/ChunkFactory.java
View File

@ -102,7 +102,6 @@ public class ChunkFactory {
* Creates the appropriate chunk at the given location.
* @param data
* @param offset
* @return
*/
public Chunk createChunk(byte[] data, int offset) {
// Create the header

1
src/scratchpad/src/org/apache/poi/hslf/model/TextRun.java
View File

@ -478,7 +478,6 @@ public class TextRun
/**
* Fetch the rich text runs (runs of text with the same styling) that
* are contained within this block of text
* @return
*/
public RichTextRun[] getRichTextRuns() {
return _rtRuns;

1
src/scratchpad/src/org/apache/poi/hslf/record/FontCollection.java
View File

@ -98,7 +98,6 @@ public class FontCollection extends RecordContainer {
* Get the name of the font at the given ID, or null if there is
* no font at that ID.
* @param id
* @return
*/
public String getFontWithId(int id) {
if(id >= fonts.size()) {

11
src/scratchpad/src/org/apache/poi/hssf/record/formula/eval/AreaEval.java
View File

@ -29,28 +29,24 @@ public interface AreaEval extends ValueEval {
/**
* returns the 0-based index of the first row in
* this area.
* @return
*/
public int getFirstRow();
/**
* returns the 0-based index of the last row in
* this area.
* @return
*/
public int getLastRow();
/**
* returns the 0-based index of the first col in
* this area.
* @return
*/
public short getFirstColumn();
/**
* returns the 0-based index of the last col in
* this area.
* @return
*/
public short getLastColumn();
@ -58,7 +54,6 @@ public interface AreaEval extends ValueEval {
* returns true if the Area's start and end row indexes
* are same. This result of this method should agree
* with getFirstRow() == getLastRow().
* @return
*/
public boolean isRow();
@ -66,7 +61,6 @@ public interface AreaEval extends ValueEval {
* returns true if the Area's start and end col indexes
* are same. This result of this method should agree
* with getFirstColumn() == getLastColumn().
* @return
*/
public boolean isColumn();
@ -74,7 +68,6 @@ public interface AreaEval extends ValueEval {
* The array of values in this area. Although the area
* maybe 1D (ie. isRow() or isColumn() returns true) or 2D
* the returned array is 1D.
* @return
*/
public ValueEval[] getValues();
@ -86,7 +79,6 @@ public interface AreaEval extends ValueEval {
* bre returned.
* @param row
* @param col
* @return
*/
public ValueEval getValueAt(int row, short col);
@ -96,21 +88,18 @@ public interface AreaEval extends ValueEval {
* this area.
* @param row
* @param col
* @return
*/
public boolean contains(int row, short col);
/**
* returns true if the specified col is in range
* @param col
* @return
*/
public boolean containsColumn(short col);
/**
* returns true if the specified row is in range
* @param row
* @return
*/
public boolean containsRow(int row);
}

4
src/scratchpad/src/org/apache/poi/hssf/record/formula/eval/RefEval.java
View File

@ -40,19 +40,16 @@ public interface RefEval extends ValueEval {
* the RefEval representing
* A1 will return as the getInnerValueEval() the
* object of concrete type StringEval
* @return
*/
public ValueEval getInnerValueEval();
/**
* returns the column index.
* @return
*/
public short getColumn();
/**
* returns the row index.
* @return
*/
public short getRow();
@ -66,7 +63,6 @@ public interface RefEval extends ValueEval {
* B1 has the value "test", then the RefEval
* representing A1 will return isEvaluated()
* equal to true.
* @return
*/
public boolean isEvaluated();

1
src/scratchpad/src/org/apache/poi/hssf/record/formula/eval/StringOperationEval.java
View File

@ -34,7 +34,6 @@ public abstract class StringOperationEval implements OperationEval {
* @param eval
* @param srcRow
* @param srcCol
* @return
*/
protected ValueEval singleOperandEvaluate(Eval eval, int srcRow, short srcCol) {
ValueEval retval;

5
src/scratchpad/src/org/apache/poi/hssf/record/formula/eval/ValueEvalToNumericXlator.java
View File

@ -61,7 +61,6 @@ public class ValueEvalToNumericXlator {
* The params can be either NumberEval, BoolEval, StringEval, or
* RefEval
* @param eval
* @return
*/
public ValueEval attemptXlateToNumeric(ValueEval eval) {
ValueEval retval = null;
@ -114,7 +113,6 @@ public class ValueEvalToNumericXlator {
* instance. If flag is set, a zero
* valued numbereval is returned, else BlankEval.INSTANCE
* is returned.
* @return
*/
private ValueEval xlateBlankEval(int flag) {
return ((flags & flag) > 0)
@ -125,7 +123,6 @@ public class ValueEvalToNumericXlator {
/**
* uses the relevant flags to decode the supplied RefVal
* @param eval
* @return
*/
private ValueEval xlateRefEval(RefEval reval) {
ValueEval retval = null;
@ -177,7 +174,6 @@ public class ValueEvalToNumericXlator {
/**
* uses the relevant flags to decode the StringEval
* @param eval
* @return
*/
private ValueEval xlateStringEval(StringEval eval) {
ValueEval retval = null;
@ -224,7 +220,6 @@ public class ValueEvalToNumericXlator {
/**
* uses the relevant flags to decode the StringEval
* @param eval
* @return
*/
private ValueEval xlateRefStringEval(StringEval eval) {
ValueEval retval = null;

5
src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/FinanceLib.java
View File

@ -77,7 +77,6 @@ public final class FinanceLib {
* @param y pmt per period
* @param f future value
* @param t type (true=pmt at end of period, false=pmt at begining of period)
* @return
*/
public static double fv(double r, double n, double y, double p, boolean t) {
double retval = 0;
@ -103,7 +102,6 @@ public final class FinanceLib {
* @param y
* @param f
* @param t
* @return
*/
public static double pv(double r, double n, double y, double f, boolean t) {
double retval = 0;
@ -127,7 +125,6 @@ public final class FinanceLib {
* value should be negative.
* @param r
* @param cfs cashflow amounts
* @return
*/
public static double npv(double r, double[] cfs) {
double npv = 0;
@ -147,7 +144,6 @@ public final class FinanceLib {
* @param p
* @param f
* @param t
* @return
*/
public static double pmt(double r, double n, double p, double f, boolean t) {
double retval = 0;
@ -170,7 +166,6 @@ public final class FinanceLib {
* @param p
* @param f
* @param t
* @return
*/
public static double nper(double r, double y, double p, double f, boolean t) {
double retval = 0;

1
src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/Len.java
View File

@ -121,7 +121,6 @@ public class Len extends TextFunction {
* Note: AreaEvals are not handled, if arg is an AreaEval,
* the returned value is ErrorEval.VALUE_INVALID
* @param ve
* @return
*/
protected ValueEval attemptXlateToText(ValueEval ve) {
ValueEval retval;

1
src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/LogicalFunction.java
View File

@ -32,7 +32,6 @@ public abstract class LogicalFunction implements Function {
/**
* recursively evaluate any RefEvals
* @param reval
* @return
*/
protected ValueEval xlateRefEval(RefEval reval) {
ValueEval retval = (ValueEval) reval.getInnerValueEval();

25
src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/MathX.java
View File

@ -48,7 +48,6 @@ public final class MathX {
* <p>If n is NaN, returned value is NaN.
* @param n
* @param p
* @return
*/
public static double round(double n, int p) {
double retval;
@ -83,7 +82,6 @@ public final class MathX {
* <p>If n is NaN, returned value is NaN.
* @param n
* @param p
* @return
*/
public static double roundUp(double n, int p) {
double retval;
@ -127,7 +125,6 @@ public final class MathX {
* <p>If n is NaN, returned value is NaN.
* @param n
* @param p
* @return
*/
public static double roundDown(double n, int p) {
double retval;
@ -158,7 +155,6 @@ public final class MathX {
* <p> If d is NaN, then 1 will be returned. It is the responsibility
* of caller to check for d isNaN if some other value is desired.
* @param d
* @return
*/
public static short sign(double d) {
return (short) ((d == 0)
@ -171,7 +167,6 @@ public final class MathX {
/**
* average of all values
* @param values
* @return
*/
public static double average(double[] values) {
double ave = 0;
@ -187,7 +182,6 @@ public final class MathX {
/**
* sum of all values
* @param values
* @return
*/
public static double sum(double[] values) {
double sum = 0;
@ -200,7 +194,6 @@ public final class MathX {
/**
* sum of squares of all values
* @param values
* @return
*/
public static double sumsq(double[] values) {
double sumsq = 0;
@ -214,7 +207,6 @@ public final class MathX {
/**
* product of all values
* @param values
* @return
*/
public static double product(double[] values) {
double product = 0;
@ -231,7 +223,6 @@ public final class MathX {
* min of all values. If supplied array is zero length,
* Double.POSITIVE_INFINITY is returned.
* @param values
* @return
*/
public static double min(double[] values) {
double min = Double.POSITIVE_INFINITY;
@ -245,7 +236,6 @@ public final class MathX {
* min of all values. If supplied array is zero length,
* Double.NEGATIVE_INFINITY is returned.
* @param values
* @return
*/
public static double max(double[] values) {
double max = Double.NEGATIVE_INFINITY;
@ -269,7 +259,6 @@ public final class MathX {
* In all such cases, Double.NaN is returned.
* @param n
* @param s
* @return
*/
public static double floor(double n, double s) {
double f;
@ -298,7 +287,6 @@ public final class MathX {
* In all such cases, Double.NaN is returned.
* @param n
* @param s
* @return
*/
public static double ceiling(double n, double s) {
double c;
@ -322,7 +310,6 @@ public final class MathX {
* than Double.MAX_VALUE; Double.POSITIVE_INFINITY is returned.
* If n < 0, Double.NaN is returned.
* @param n
* @return
*/
public static double factorial(int n) {
double d = 1;
@ -358,7 +345,6 @@ public final class MathX {
* If d == 0, result is NaN
* @param n
* @param d
* @return
*/
public static double mod(double n, double d) {
double result = 0;
@ -385,7 +371,6 @@ public final class MathX {
/**
* inverse hyperbolic cosine
* @param d
* @return
*/
public static double acosh(double d) {
return Math.log(Math.sqrt(Math.pow(d, 2) - 1) + d);
@ -394,7 +379,6 @@ public final class MathX {
/**
* inverse hyperbolic sine
* @param d
* @return
*/
public static double asinh(double d) {
double d2 = d*d;
@ -404,7 +388,6 @@ public final class MathX {
/**
* inverse hyperbolic tangent
* @param d
* @return
*/
public static double atanh(double d) {
return Math.log((1 + d)/(1 - d)) / 2;
@ -413,7 +396,6 @@ public final class MathX {
/**
* hyperbolic cosine
* @param d
* @return
*/
public static double cosh(double d) {
double ePowX = Math.pow(Math.E, d);
@ -425,7 +407,6 @@ public final class MathX {
/**
* hyperbolic sine
* @param d
* @return
*/
public static double sinh(double d) {
double ePowX = Math.pow(Math.E, d);
@ -437,7 +418,6 @@ public final class MathX {
/**
* hyperbolic tangent
* @param d
* @return
*/
public static double tanh(double d) {
double ePowX = Math.pow(Math.E, d);
@ -452,7 +432,6 @@ public final class MathX {
* all the subarrays are of equal length. If the subarrays are
* not of equal length, the return value can be unpredictable.
* @param arrays
* @return
*/
public static double sumproduct(double[][] arrays) {
double d = 0;
@ -485,7 +464,6 @@ public final class MathX {
* subarrays are not of equal length, the return value can be
* unpredictable.
* @param arrays
* @return
*/
public static double sumx2my2(double[] xarr, double[] yarr) {
double d = 0;
@ -511,7 +489,6 @@ public final class MathX {
* subarrays are not of equal length, the return value can be
* unpredictable.
* @param arrays
* @return
*/
public static double sumx2py2(double[] xarr, double[] yarr) {
double d = 0;
@ -538,7 +515,6 @@ public final class MathX {
* subarrays are not of equal length, the return value can be
* unpredictable.
* @param arrays
* @return
*/
public static double sumxmy2(double[] xarr, double[] yarr) {
double d = 0;
@ -565,7 +541,6 @@ public final class MathX {
* If either of the parameters is negative, Double.NaN is returned.
* @param n
* @param k
* @return
*/
public static double nChooseK(int n, int k) {
double d = 1;

4
src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/MultiOperandNumericFunction.java
View File

@ -66,7 +66,6 @@ public abstract class MultiOperandNumericFunction extends NumericFunction {
/**
* Maximum number of operands accepted by this function.
* Subclasses may override to change default value.
* @return
*/
protected int getMaxNumOperands() {
return DEFAULT_MAX_NUM_OPERANDS;
@ -82,7 +81,6 @@ public abstract class MultiOperandNumericFunction extends NumericFunction {
* @param operands
* @param srcRow
* @param srcCol
* @return
*/
protected double[] getNumberArray(Eval[] operands, int srcRow, short srcCol) {
double[] retval = new double[30];
@ -120,7 +118,6 @@ public abstract class MultiOperandNumericFunction extends NumericFunction {
* @param operand
* @param srcRow
* @param srcCol
* @return
*/
protected double[] getNumberArray(Eval operand, int srcRow, short srcCol) {
double[] retval;
@ -184,7 +181,6 @@ public abstract class MultiOperandNumericFunction extends NumericFunction {
* @param arr
* @param pos
* @param d
* @return
*/
private static double[] putInArray(double[] arr, int pos, double d) {
double[] tarr = arr;

4
src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/StatsLib.java
View File

@ -35,7 +35,6 @@ public final class StatsLib {
/**
* returns the mean of deviations from mean.
* @param v
* @return
*/
public static double avedev(double[] v) {
double r = 0;
@ -66,7 +65,6 @@ public final class StatsLib {
* is Double.NaN. Else returns the value that occurs most times
* and if there is a tie, returns the first such value.
* @param v
* @return
*/
public static double mode(double[] v) {
double r = Double.NaN;
@ -139,7 +137,6 @@ public final class StatsLib {
* will result in return value Double.NaN
* @param v
* @param k
* @return
*/
public static double kthLargest(double[] v, int k) {
double r = Double.NaN;
@ -160,7 +157,6 @@ public final class StatsLib {
* will result in return value Double.NaN
* @param v
* @param k
* @return
*/
public static double kthSmallest(double[] v, int k) {
double r = Double.NaN;

1
src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/TextFunction.java
View File

@ -77,7 +77,6 @@ public abstract class TextFunction implements Function {
* Note: AreaEvals are not handled, if arg is an AreaEval,
* the returned value is ErrorEval.VALUE_INVALID
* @param ve
* @return
*/
protected ValueEval attemptXlateToText(ValueEval ve) {
ValueEval retval;

1
src/scratchpad/src/org/apache/poi/hssf/record/formula/functions/XYNumericFunction.java
View File

@ -74,7 +74,6 @@ public abstract class XYNumericFunction extends NumericFunction {
* @param operands
* @param srcRow
* @param srcCol
* @return
*/
protected double[][] getNumberArray(Eval[] xops, Eval[] yops, int srcRow, short srcCol) {
double[][] retval = new double[2][30];

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

@ -171,7 +171,6 @@ public class HSSFFormulaEvaluator {
* evaluateInCell() when the call should not modify the contents of the
* original cell.
* @param cell
* @return
*/
public CellValue evaluate(HSSFCell cell) {
CellValue retval = null;
@ -249,7 +248,6 @@ public class HSSFFormulaEvaluator {
/**
* Returns a CellValue wrapper around the supplied ValueEval instance.
* @param eval
* @return
*/
protected static CellValue getCellValueForEval(ValueEval eval) {
CellValue retval = null;
@ -287,7 +285,6 @@ public class HSSFFormulaEvaluator {
* @param formula
* @param sheet
* @param workbook
* @return
*/
protected static ValueEval internalEvaluate(HSSFCell srcCell, HSSFRow srcRow, HSSFSheet sheet, HSSFWorkbook workbook) {
int srcRowNum = srcRow.getRowNum();
@ -409,7 +406,6 @@ public class HSSFFormulaEvaluator {
* returns the OperationEval concrete impl instance corresponding
* to the suplied operationPtg
* @param ptg
* @return
*/
protected static Eval getOperationEvalForPtg(OperationPtg ptg) {
Eval retval = null;
@ -432,7 +428,6 @@ public class HSSFFormulaEvaluator {
* passed here!
*
* @param ptg
* @return
*/
protected static Eval getEvalForPtg(Ptg ptg) {
Eval retval = null;
@ -478,7 +473,6 @@ public class HSSFFormulaEvaluator {
* @param cell
* @param sheet
* @param workbook
* @return
*/
protected static ValueEval getEvalForCell(HSSFCell cell, HSSFRow row, HSSFSheet sheet, HSSFWorkbook workbook) {
ValueEval retval = BlankEval.INSTANCE;

2
src/testcases/org/apache/poi/util/LocalTestNode.java
View File

@ -77,8 +77,6 @@ class LocalTestNode
* Method compareTo
*
* @param o
*
* @return
*/
public int compareTo(Object o)