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

Javadoc fixes 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1782939 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Nick Burch 2017-02-14 09:35:43 +00:00
parent 7100833993
commit dc5de7c11b
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
View File

@ -141,8 +141,8 @@ public class ConditionalFormattingEvaluator {
* formula by the relative position of the current cell, or the wrong value is checked. * formula by the relative position of the current cell, or the wrong value is checked.
* This is handled by {@link WorkbookEvaluator#evaluate(String, CellReference, CellRangeAddressBase)}. * This is handled by {@link WorkbookEvaluator#evaluate(String, CellReference, CellRangeAddressBase)}.
* *
* @param cell NOTE: if no sheet name is specified, this uses the workbook active sheet * @param cellRef NOTE: if no sheet name is specified, this uses the workbook active sheet
* @return Unmodifiable List of {@link EvaluationConditionalFormattingRule}s that apply to the current cell value, * @return Unmodifiable List of {@link EvaluationConditionalFormatRule}s that apply to the current cell value,
* in priority order, as evaluated by Excel (smallest priority # for XSSF, definition order for HSSF), * in priority order, as evaluated by Excel (smallest priority # for XSSF, definition order for HSSF),
* or null if none apply * or null if none apply
*/ */
@ -172,7 +172,7 @@ public class ConditionalFormattingEvaluator {
* This is handled by {@link WorkbookEvaluator#evaluate(String, CellReference, CellRangeAddressBase)}. * This is handled by {@link WorkbookEvaluator#evaluate(String, CellReference, CellRangeAddressBase)}.
* *
* @param cell * @param cell
* @return Unmodifiable List of {@link EvaluationConditionalFormattingRule}s that apply to the current cell value, * @return Unmodifiable List of {@link EvaluationConditionalFormatRule}s that apply to the current cell value,
* in priority order, as evaluated by Excel (smallest priority # for XSSF, definition order for HSSF), * in priority order, as evaluated by Excel (smallest priority # for XSSF, definition order for HSSF),
* or null if none apply * or null if none apply
*/ */
@ -243,7 +243,8 @@ public class ConditionalFormattingEvaluator {
* We could overload this with convenience methods taking a sheet name and sheet index as well. * We could overload this with convenience methods taking a sheet name and sheet index as well.
* <p/> * <p/>
* @param sheet containing the rule * @param sheet containing the rule
* @param index of the {@link ConditionalFormatting} instance in the sheet's array * @param conditionalFormattingIndex of the {@link ConditionalFormatting} instance in the sheet's array
* @param ruleIndex of the {@link ConditionalFormattingRule} instance within the {@link ConditionalFormatting}
* @return unmodifiable List of all cells in the rule's region matching the rule's condition * @return unmodifiable List of all cells in the rule's region matching the rule's condition
*/ */
public List<Cell> getMatchingCells(Sheet sheet, int conditionalFormattingIndex, int ruleIndex) { public List<Cell> getMatchingCells(Sheet sheet, int conditionalFormattingIndex, int ruleIndex) {

3
src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
View File

@ -106,7 +106,7 @@ public interface ConditionalFormattingRule {
* <p/> * <p/>
* This object contains the additional configuration information for XSSF filter conditions. * This object contains the additional configuration information for XSSF filter conditions.
* *
* @return * @return the Filter Configuration Data, or null if there isn't any
*/ */
public ConditionFilterData getFilterConfiguration(); public ConditionFilterData getFilterConfiguration();
@ -153,7 +153,6 @@ public interface ConditionalFormattingRule {
* If priority is 0, just use definition order, as that's how HSSF rules are evaluated. * If priority is 0, just use definition order, as that's how HSSF rules are evaluated.
* <p/> * <p/>
* If a rule is created but not yet added to a sheet, this value may not be valid. * If a rule is created but not yet added to a sheet, this value may not be valid.
* @return rule priority * @return rule priority
*/ */
int getPriority(); int getPriority();