Author: nick
Date: Tue Feb 14 09:35:43 2017
New Revision: 1782939
URL: http://svn.apache.org/viewvc?rev=1782939&view=rev
Log:
Javadoc fixes
Modified:
poi/trunk/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
poi/trunk/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
Modified:
poi/trunk/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java?rev=1782939&r1=1782938&r2=1782939&view=diff
==============================================================================
---
poi/trunk/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
(original)
+++
poi/trunk/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
Tue Feb 14 09:35:43 2017
@@ -141,8 +141,8 @@ public class ConditionalFormattingEvalua
* 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)}.
*
- * @param cell 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,
+ * @param cellRef NOTE: if no sheet name is specified, this uses the
workbook active sheet
+ * @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),
* or null if none apply
*/
@@ -172,7 +172,7 @@ public class ConditionalFormattingEvalua
* This is handled by {@link WorkbookEvaluator#evaluate(String,
CellReference, CellRangeAddressBase)}.
*
* @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),
* or null if none apply
*/
@@ -243,7 +243,8 @@ public class ConditionalFormattingEvalua
* We could overload this with convenience methods taking a sheet name and
sheet index as well.
* <p/>
* @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
*/
public List<Cell> getMatchingCells(Sheet sheet, int
conditionalFormattingIndex, int ruleIndex) {
Modified:
poi/trunk/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
URL:
http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java?rev=1782939&r1=1782938&r2=1782939&view=diff
==============================================================================
---
poi/trunk/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
(original)
+++
poi/trunk/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
Tue Feb 14 09:35:43 2017
@@ -106,7 +106,7 @@ public interface ConditionalFormattingRu
* <p/>
* 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();
@@ -153,7 +153,6 @@ public interface ConditionalFormattingRu
* If priority is 0, just use definition order, as that's how HSSF rules
are evaluated.
* <p/>
* If a rule is created but not yet added to a sheet, this value may not
be valid.
-
* @return rule priority
*/
int getPriority();
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
