Javadoc fixes

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1782939 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java b/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
index 81af9b0848d2632e73658c7372ffec5ba56b0ab0..a06ac0879d55a4f10cc3a602855bc3f4036e1158 100644 (file)
--- a/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
+++ b/src/java/org/apache/poi/ss/formula/ConditionalFormattingEvaluator.java
@@ -141,8 +141,8 @@ public class ConditionalFormattingEvaluator {
      * 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 ConditionalFormattingEvaluator {
      * 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 ConditionalFormattingEvaluator {
      * 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) {

diff --git a/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java b/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
index fa705e61d0dd095572ae9c631b2b5a53497becb2..54961ca6d092f08b4c9803f28dbe4e8c15330017 100644 (file)
--- a/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
+++ b/src/java/org/apache/poi/ss/usermodel/ConditionalFormattingRule.java
@@ -106,7 +106,7 @@ public interface ConditionalFormattingRule {
      * <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 ConditionalFormattingRule {
      * 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();