Mailing-List: contact dev-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Commons Developers List" <dev@commons.apache.org>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8;
 format=flowed
Content-Transfer-Encoding: 7bit
Date: Tue, 09 May 2017 15:28:17 +0200
From: Gilles <gilles@harfang.homelinux.org>
To: <dev@commons.apache.org>
Subject: Re: [4/4] commons-numbers git commit: Avoid "malformed HTML"
 javadoc error
In-Reply-To: <CAGTHBS5Bkbu3j8YAJwUUgin7rac+t_y9U+QG0fSgPTARKFFS6g@mail.gmail.com>
References: <3bdbb7ac79f041e09deb7910adc6f031@git.apache.org>
 <5f7b6b157c44473ca33a7f9d4cdf231b@git.apache.org>
 <564e414f82cc603436d3521c5a1f8ee6@scarlet.be>
 <CAGTHBS5Bkbu3j8YAJwUUgin7rac+t_y9U+QG0fSgPTARKFFS6g@mail.gmail.com>
Message-ID: <3ffb5ca3e9da3df63d2c03578e4f4c5b@scarlet.be>
User-Agent: Scarlet Webmail
X-DCC-scarlet.be-Metrics: eir; whitelist
X-Virus-Scanned: clamav-milter 0.98.1-exp at eir
X-Virus-Status: Clean
archived-at: Tue, 09 May 2017 13:28:24 -0000

On Tue, 9 May 2017 09:03:13 -0400, Raymond DeCampo wrote:
> How does MathJax interact with HTML entities?

Seems that javadoc8 breaks the build even before MathJax has the chance
to interpret the LaTeX code.

See this for a more complete answer:
   http://docs.mathjax.org/en/latest/tex.html

>
> My LateX is very rusty - is there a suitable escape sequence (like 
> the \leq
> used in other parts of the doc) that could be used instead?

See reference above; there is "\lt" (defined by "MathJax", not LaTeX 
IIUC).

Anyways, I think that we should try and use "{@code ...}" whenever the
"formula" is just stating inequalities between simple entities 
(numbers).
[See the latest Javadoc changes in branch "task_NUMBERS-33_Gamma".]

Gilles

>
>
> On Tue, May 9, 2017 at 7:17 AM, Gilles <gilles@harfang.homelinux.org> 
> wrote:
>
>> On Tue, 09 May 2017 11:09:49 -0000, stain@apache.org wrote:
>>
>>> Avoid "malformed HTML" javadoc error
>>>
>>
>> -1
>>
>> This is not malformed HTML!  It is LateX (to be interpreted by 
>> MathJax).
>>
>> Regards,
>> Gilles
>>
>>
>>
>>>
>>> Project: 
>>> http://git-wip-us.apache.org/repos/asf/commons-numbers/repo
>>> Commit:
>>>
>>> 
>>> http://git-wip-us.apache.org/repos/asf/commons-numbers/commit/851b17ec
>>> Tree: http://git-wip-us.apache.org/repos/asf/commons-numbers/tree/
>>> 851b17ec
>>> Diff: http://git-wip-us.apache.org/repos/asf/commons-numbers/diff/
>>> 851b17ec
>>>
>>> Branch: refs/heads/task_NUMBERS-33__Gamma
>>> Commit: 851b17ece739245bc04f7f03dc20cfe4c0ea60a8
>>> Parents: 8d2b162
>>> Author: Stian Soiland-Reyes <stain@apache.org>
>>> Authored: Tue May 9 11:07:20 2017 +0100
>>> Committer: Stian Soiland-Reyes <stain@apache.org>
>>> Committed: Tue May 9 12:09:40 2017 +0100
>>>
>>>
>>> 
>>> ----------------------------------------------------------------------
>>>  .../src/main/java/org/apache/commons/numbers/gamma/Digamma.java    
>>> | 2
>>> +-
>>>  .../src/main/java/org/apache/commons/numbers/gamma/LogGamma.java   
>>> | 2
>>> +-
>>>  2 files changed, 2 insertions(+), 2 deletions(-)
>>>
>>> 
>>> ----------------------------------------------------------------------
>>>
>>>
>>>
>>> http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/
>>> 851b17ec/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/num
>>> bers/gamma/Digamma.java
>>>
>>> b/commons-numbers-gamma/src/main/java/org/apache/commons/num
>>> bers/gamma/Digamma.java
>>> index a10f1df..32d7bf5 100644
>>> ---
>>>
>>> a/commons-numbers-gamma/src/main/java/org/apache/commons/num
>>> bers/gamma/Digamma.java
>>> +++
>>>
>>> b/commons-numbers-gamma/src/main/java/org/apache/commons/num
>>> bers/gamma/Digamma.java
>>> @@ -47,7 +47,7 @@ public class Digamma {
>>>       *
>>>       * Some of the constants have been changed to increase 
>>> accuracy
>>> at the moderate
>>>       * expense of run-time.  The result should be accurate to 
>>> within
>>> \( 10^{-8} \)
>>> -     * relative tolerance for \( 0 < x < 10^{-5} \) and within \(
>>> 10^{-8} \) absolute
>>> +     * relative tolerance for \( 0 &lt; x &lt; 10^{-5} \)  and
>>> within \( 10^{-8} \) absolute
>>>       * tolerance otherwise.
>>>       *
>>>       * @param x Argument.
>>>
>>>
>>> http://git-wip-us.apache.org/repos/asf/commons-numbers/blob/
>>> 851b17ec/commons-numbers-gamma/src/main/java/org/apache/
>>> commons/numbers/gamma/LogGamma.java
>>>
>>> 
>>> ----------------------------------------------------------------------
>>> diff --git
>>>
>>> a/commons-numbers-gamma/src/main/java/org/apache/commons/num
>>> bers/gamma/LogGamma.java
>>>
>>> b/commons-numbers-gamma/src/main/java/org/apache/commons/num
>>> bers/gamma/LogGamma.java
>>> index 57146a2..e4fac6e 100644
>>> ---
>>>
>>> a/commons-numbers-gamma/src/main/java/org/apache/commons/num
>>> bers/gamma/LogGamma.java
>>> +++
>>>
>>> b/commons-numbers-gamma/src/main/java/org/apache/commons/num
>>> bers/gamma/LogGamma.java
>>> @@ -34,7 +34,7 @@ public class LogGamma {
>>>      private static final LogGamma1p LOG_GAMMA_1P = 
>>> LogGamma1p.instance;
>>>
>>>      /**
>>> -     * Computes the function \( \ln \Gamma(x) \) for \( x > 0 \).
>>> +     * Computes the function \( \ln \Gamma(x) \) for \( x &gt; 0 
>>> \).
>>>       *
>>>       * For \( x \leq 8 \), the implementation is based on the 
>>> double
>>> precision
>>>       * implementation in the <em>NSWC Library of Mathematics
>>> Subroutines</em>,
>>>
>>
>>
>> 
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>>
>>


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org