javadocs

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

diff --git a/src/testcases/org/apache/poi/ss/usermodel/BaseTestBugzillaIssues.java b/src/testcases/org/apache/poi/ss/usermodel/BaseTestBugzillaIssues.java
index 2af5c388702ed6560430098fe9a2ae5b404a6cae..7e04f12d732bc892be58370a70bc039577833b82 100644 (file)
--- a/src/testcases/org/apache/poi/ss/usermodel/BaseTestBugzillaIssues.java
+++ b/src/testcases/org/apache/poi/ss/usermodel/BaseTestBugzillaIssues.java
@@ -56,6 +56,11 @@ public abstract class BaseTestBugzillaIssues {
         _testDataProvider = testDataProvider;
     }
 
+    /**
+     * Unlike org.junit.Assert.assertEquals(double expected, double actual, double delta),
+     * where delta is an absolute error value, this function's factor is a relative error,
+     * so it's easier to express "actual is within 5% of expected".
+     */
     public static void assertAlmostEquals(double expected, double actual, float factor) {
         double diff = Math.abs(expected - actual);
         double fuzz = expected * factor;