support gcd function

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

diff --git a/poi/src/main/java/org/apache/poi/ss/formula/functions/Gcd.java b/poi/src/main/java/org/apache/poi/ss/formula/functions/Gcd.java
index 6b6f051607edf4ab704b779149445125a2ebd75c..a77a7bd67142b20ff5b6f31e423163ce77638016 100644 (file)
--- a/poi/src/main/java/org/apache/poi/ss/formula/functions/Gcd.java
+++ b/poi/src/main/java/org/apache/poi/ss/formula/functions/Gcd.java
@@ -26,6 +26,19 @@ import org.apache.poi.ss.formula.eval.ValueEval;
 
 import java.util.ArrayList;
 
+
+/**
+ * Implementation for Excel GCD() function.
+ * <p>
+ *   <b>Syntax</b>:<br> <b>GCD  </b>(<b>number</b>, ...)<br>
+ * </p>
+ * <p>
+ *   Returns the greatest common divisor of two or more integers. The greatest common divisor is the largest integer that divides both number1 and number2 without a remainder.
+ * </p>
+ * <p>
+ *   See https://support.microsoft.com/en-us/office/gcd-function-d5107a51-69e3-461f-8e4c-ddfc21b5073a
+ * </p>
+ */
 public class Gcd implements FreeRefFunction {
 
     public static final Gcd instance = new Gcd();