Improve Javadoc
Project: http://git-wip-us.apache.org/repos/asf/commons-numbers/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-numbers/commit/f33d53e4 Tree: http://git-wip-us.apache.org/repos/asf/commons-numbers/tree/f33d53e4 Diff: http://git-wip-us.apache.org/repos/asf/commons-numbers/diff/f33d53e4 Branch: refs/heads/master Commit: f33d53e47f92fd7327d36667db7887025c1a5047 Parents: b266dc1 Author: Stian Soiland-Reyes <st...@apache.org> Authored: Tue May 9 13:08:58 2017 +0100 Committer: Stian Soiland-Reyes <st...@apache.org> Committed: Tue May 9 13:08:58 2017 +0100 ---------------------------------------------------------------------- .../org/apache/commons/numbers/gamma/Digamma.java | 8 ++++++-- .../org/apache/commons/numbers/gamma/Gamma.java | 16 ++++++++++++---- 2 files changed, 18 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/f33d53e4/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/Digamma.java ---------------------------------------------------------------------- diff --git a/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/Digamma.java b/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/Digamma.java index 32d7bf5..d83cf5b 100644 --- a/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/Digamma.java +++ b/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/Digamma.java @@ -18,9 +18,13 @@ package org.apache.commons.numbers.gamma; /** * <a href="http://en.wikipedia.org/wiki/Digamma_function";>Digamma function</a>. - * - * It is defined as the logarithmic derivative of the \( \Gamma \) function: + * <p> + * It is defined as the logarithmic derivative of the \( \Gamma \) + * ({@link Gamma}) function: * \( \frac{d}{dx}(\ln \Gamma(x)) = \frac{\Gamma^\prime(x)}{\Gamma(x)} \). + * </p> + * + * @see Gamma */ public class Digamma { /** <a href="http://en.wikipedia.org/wiki/Euler-Mascheroni_constant";>Euler-Mascheroni constant</a>. */ http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/f33d53e4/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/Gamma.java ---------------------------------------------------------------------- diff --git a/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/Gamma.java b/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/Gamma.java index 797c93a..8906734 100644 --- a/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/Gamma.java +++ b/commons-numbers-gamma/src/main/java/org/apache/commons/numbers/gamma/Gamma.java @@ -18,9 +18,17 @@ package org.apache.commons.numbers.gamma; /** - * <a href="http://mathworld.wolfram.com/GammaFunction.html";>Gamma function</a>. - * - * Class is immutable. + * <a href="http://mathworld.wolfram.com/GammaFunction.html";>Gamma + * function</a>. + * <p> + * The <a href="http://mathworld.wolfram.com/GammaFunction.html";>gamma + * function</a> can be seen to extend the factorial function to cover real and + * complex numbers, but with its argument shifted by {@code -1}. This + * implementation supports real numbers. + * </p> + * <p> + * This class is immutable. + * </p> */ public class Gamma { /** \( g = \frac{607}{128} \). */ @@ -34,7 +42,7 @@ public class Gamma { /** * Computes the value of \( \Gamma(x) \). - * + * <p> * Based on the <em>NSWC Library of Mathematics Subroutines</em> double * precision implementation, {@code DGAMMA}. *
