Note on arguments

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

diff --git a/src/java/org/apache/poi/ss/formula/functions/IfFunc.java b/src/java/org/apache/poi/ss/formula/functions/IfFunc.java
index 2af174f9dfc2da12131570c528c0a7aa5151d8c1..d410350b7c9770a924dc89bbecd5eabb5f964394 100644 (file)
--- a/src/java/org/apache/poi/ss/formula/functions/IfFunc.java
+++ b/src/java/org/apache/poi/ss/formula/functions/IfFunc.java
@@ -23,11 +23,18 @@ import org.apache.poi.ss.formula.eval.EvaluationException;
 import org.apache.poi.ss.formula.eval.MissingArgEval;
 import org.apache.poi.ss.formula.eval.OperandResolver;
 import org.apache.poi.ss.formula.eval.ValueEval;
+import org.apache.poi.ss.formula.ptg.Ptg;
+import org.apache.poi.ss.formula.ptg.RefPtg;
 
 /**
  * Implementation for the Excel function IF
- *
- * @author Amol S. Deshmukh < amolweb at ya hoo dot com >
+ * <p>
+ * Note that Excel is a bit picky about the arguments to this function,
+ *  when serialised into {@link Ptg}s in a HSSF file. While most cases are
+ *  pretty chilled about the R vs V state of {@link RefPtg} arguments,
+ *  for IF special care is needed to avoid Excel showing #VALUE.
+ * See bug numbers #55324 and #55747 for the full details on this.
+ * TODO Fix this...
  */
 public final class IfFunc extends Var2or3ArgFunction {