Author: nick
Date: Tue Feb 14 09:45:45 2017
New Revision: 1782941
URL: http://svn.apache.org/viewvc?rev=1782941&view=rev
Log:
Javadoc fixes
Modified:
poi/trunk/src/java/org/apache/poi/ss/formula/DataValidationEvaluator.java
poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.java
poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
Modified:
poi/trunk/src/java/org/apache/poi/ss/formula/DataValidationEvaluator.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/DataValidationEvaluator.java?rev=1782941&r1=1782940&r2=1782941&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/DataValidationEvaluator.java
(original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/DataValidationEvaluator.java
Tue Feb 14 09:45:45 2017
@@ -82,9 +82,9 @@ public class DataValidationEvaluator {
}
/**
- * lazy load validations by sheet, since reading the CT* types is expensive
+ * Lazy load validations by sheet, since reading the CT* types is expensive
* @param sheet
- * @return
+ * @return The {@link DataValidation}s for the sheet
*/
private List<? extends DataValidation> getValidations(Sheet sheet) {
List<? extends DataValidation> dvs =
validations.get(sheet.getSheetName());
@@ -130,7 +130,7 @@ public class DataValidationEvaluator {
}
/**
- * If {@link #getValidationForCell(Cell)} returns an instance, and the
+ * If {@link #getValidationForCell(CellReference)} returns an instance,
and the
* {@link ValidationType} is {@link ValidationType#LIST}, return the valid
* values, whether they are from a static list or cell range.
* <p/>
@@ -155,8 +155,6 @@ public class DataValidationEvaluator {
/**
* static so enums can reference it without creating a whole instance
- * @param cell
- * @param val
* @return returns an unmodifiable {@link List} of {@link ValueEval}s,
which may be empty
*/
protected static List<ValueEval>
getValidationValuesForConstraint(DataValidationContext context) {
@@ -189,7 +187,7 @@ public class DataValidationEvaluator {
}
/**
- * Use the validation returned by {@link #getValidationForCell(Cell)} if
you
+ * Use the validation returned by {@link
#getValidationForCell(CellReference)} if you
* want the error display details. This is the validation checked by this
* method, which attempts to replicate Excel's data validation rules.
* <p/>
@@ -197,7 +195,7 @@ public class DataValidationEvaluator {
* offset the base validation formula by the relative position of the
* current cell, or the wrong value is checked.
*
- * @param cell
+ * @param cellRef The reference of the cell to evaluate
* @return true if the cell has no validation or the cell value passes the
* defined validation, false if it fails
*/
@@ -351,10 +349,7 @@ public class DataValidationEvaluator {
* We won't re-evaluate cells here. This validation would be after
the cell value was updated externally.
* Excel allows invalid values through methods like copy/paste, and
only validates them when the user
* interactively edits the cell.
- * @param cell
- * @param dvc
- * @param wbe
- * @return
+ * @return if the cell is a valid numeric cell for the validation or
not
*/
protected boolean isValidNumericCell(Cell cell, DataValidationContext
context) {
if ( ! isType(cell, CellType.NUMERIC)) return false;
@@ -364,10 +359,7 @@ public class DataValidationEvaluator {
}
/**
- *
- * @param value
- * @param context
- * @return
+ * Is the number a valid option for the validation?
*/
protected boolean isValidNumericValue(Double value, final
DataValidationContext context) {
try {
@@ -419,10 +411,9 @@ public class DataValidationEvaluator {
}
/**
- * Validates against the type defined in dvc, as an index of the enum
values array.
- * @param cell
- * @param dvc
- * @param wbe
+ * Validates against the type defined in context, as an index of the
enum values array.
+ * @param cell Cell to check validity of
+ * @param context The Data Validation to check against
* @return true if validation passes
* @throws ArrayIndexOutOfBoundsException if the constraint type is an
invalid index
*/
Modified:
poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.java?rev=1782941&r1=1782940&r2=1782941&view=diff
==============================================================================
---
poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.java
(original)
+++
poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationConditionalFormatRule.java
Tue Feb 14 09:45:45 2017
@@ -266,9 +266,9 @@ public class EvaluationConditionalFormat
}
/**
- * @param cell
+ * @param cell the cell to check for
* @param region for adjusting relative formulas
- * @return
+ * @return if the value of the cell is valid or not for the formatting rule
*/
private boolean checkValue(Cell cell, CellRangeAddress region) {
if (cell == null || DataValidationEvaluator.isType(cell,
CellType.BLANK)
@@ -518,7 +518,7 @@ public class EvaluationConditionalFormat
* numbers stored as text are ignored, but numbers formatted as text are
treated as numbers.
*
* @param region
- * @return
+ * @return the meaningful values in the range of cells specified
*/
private Set<ValueAndFormat> getMeaningfulValues(CellRangeAddress region,
boolean withText, ValueFunction func) {
Set<ValueAndFormat> values = meaningfulRegionValues.get(region);
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java?rev=1782941&r1=1782940&r2=1782941&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java
(original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/WorkbookEvaluator.java Tue Feb
14 09:45:45 2017
@@ -731,7 +731,6 @@ public final class WorkbookEvaluator {
*
* @param formula to evaluate
* @param ref defines the sheet and optionally row/column base for the
formula, if it is relative
- * @param formulaType used in some contexts to define branches of logic
* @return value
* @throws IllegalArgumentException if ref does not define a sheet name to
evaluate the formula on.
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
