You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by st...@apache.org on 2017/05/09 12:09:18 UTC
[1/3] commons-numbers git commit: NUMBERS-36: Set javadoc-plugin for
as well
Repository: commons-numbers
Updated Branches:
refs/heads/task_NUMBERS-33__Gamma 851b17ece -> f33d53e47
NUMBERS-36: Set javadoc-plugin for <build> as well
Project: http://git-wip-us.apache.org/repos/asf/commons-numbers/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-numbers/commit/6dbe8485
Tree: http://git-wip-us.apache.org/repos/asf/commons-numbers/tree/6dbe8485
Diff: http://git-wip-us.apache.org/repos/asf/commons-numbers/diff/6dbe8485
Branch: refs/heads/task_NUMBERS-33__Gamma
Commit: 6dbe8485ce08c5571fbe34e2f6e4d05ba0440e13
Parents: b29de0e
Author: Stian Soiland-Reyes <st...@apache.org>
Authored: Tue May 9 12:14:23 2017 +0100
Committer: Stian Soiland-Reyes <st...@apache.org>
Committed: Tue May 9 12:14:23 2017 +0100
----------------------------------------------------------------------
pom.xml | 18 ++++++++++++++++--
1 file changed, 16 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/6dbe8485/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index aacedb7..1d04c4b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -122,6 +122,7 @@
<numbers.findbugs.version>3.0.2</numbers.findbugs.version>
<numbers.checkstyle.version>2.17</numbers.checkstyle.version>
<numbers.clirr.version>2.7</numbers.clirr.version>
+ <numbers.mathjax.version>2.7.1</numbers.mathjax.version>
<!-- Workaround to avoid duplicating config files. -->
<numbers.parent.dir>${basedir}</numbers.parent.dir>
@@ -240,6 +241,18 @@
</excludes>
</configuration>
</plugin>
+
+ <plugin>
+ <!-- NOTE: javadoc config must also be set under <reporting> -->
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <!-- Enable MathJax -->
+ <additionalparam>-Xdoclint:all --allow-script-in-comments -header '<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/${numbers.mathjax.version}/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>'</additionalparam>
+ <!-- <aggregate>true</aggregate> -->
+ </configuration>
+ </plugin>
+
</plugins>
<pluginManagement>
@@ -361,12 +374,13 @@
</reportSet>
</reportSets>
</plugin>
- <!-- MathJax -->
<plugin>
+ <!-- NOTE: javadoc config must also be set under <build> -->
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
- <additionalparam>-Xdoclint:all --allow-script-in-comments -header '<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>'</additionalparam>
+ <!-- Enable MathJax -->
+ <additionalparam>-Xdoclint:all --allow-script-in-comments -header '<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/${numbers.mathjax.version}/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>'</additionalparam>
<!-- <aggregate>true</aggregate> -->
</configuration>
</plugin>
[3/3] commons-numbers git commit: Improve Javadoc
Posted by st...@apache.org.
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/task_NUMBERS-33__Gamma
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}.
*
[2/3] commons-numbers git commit: Merge branch 'master' into
task_NUMBERS-33__Gamma
Posted by st...@apache.org.
Merge branch 'master' into task_NUMBERS-33__Gamma
Project: http://git-wip-us.apache.org/repos/asf/commons-numbers/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-numbers/commit/b266dc10
Tree: http://git-wip-us.apache.org/repos/asf/commons-numbers/tree/b266dc10
Diff: http://git-wip-us.apache.org/repos/asf/commons-numbers/diff/b266dc10
Branch: refs/heads/task_NUMBERS-33__Gamma
Commit: b266dc109b586817f7946fd1e44410591e4d768c
Parents: 851b17e 6dbe848
Author: Stian Soiland-Reyes <st...@apache.org>
Authored: Tue May 9 12:17:10 2017 +0100
Committer: Stian Soiland-Reyes <st...@apache.org>
Committed: Tue May 9 12:17:10 2017 +0100
----------------------------------------------------------------------
pom.xml | 18 ++++++++++++++++--
1 file changed, 16 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/b266dc10/pom.xml
----------------------------------------------------------------------