MATH-1511: Fix MathJax setup and guidelines for Javadoc.
This commit is contained in:
parent
6f361582b2
commit
af4962c3c6
|
@ -83,7 +83,7 @@
|
||||||
</menu>
|
</menu>
|
||||||
|
|
||||||
<head>
|
<head>
|
||||||
<![CDATA[<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" />]]>
|
<![CDATA[<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>]]>
|
||||||
</head>
|
</head>
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
|
|
|
@ -183,13 +183,12 @@
|
||||||
Commons math javadoc generation now supports embedded LaTeX formulas via the
|
Commons math javadoc generation now supports embedded LaTeX formulas via the
|
||||||
<a href="http://www.mathjax.org">MathJax</a> javascript display engine. To
|
<a href="http://www.mathjax.org">MathJax</a> javascript display engine. To
|
||||||
embed mathematical expressions formatted in LaTeX in javadoc, simply surround
|
embed mathematical expressions formatted in LaTeX in javadoc, simply surround
|
||||||
the expression to be formatted with either \( and \) for inline
|
the expression to be formatted with either <source>\( ... \)</source> for inline
|
||||||
formulas, or \[ and \] to have the formula appear on a separate line.
|
formulas, or <source>\[ ... \]</source> to have the formula appear on a separate line.
|
||||||
For example, \(a^2 + b^2 = c^2\) will render an in-line formula
|
For example, <source>\(a^2 + b^2 = c^2\)</source> will render an inline formula
|
||||||
saying that (a, b, c) is Pythagorean triplet. Using \[ and \] on
|
saying that (a, b, c) is Pythagorean triplet: \( a^2 + b^2 = c^2 \).
|
||||||
the ends will render the same formula on a separate line. See the MathJax
|
See the MathJax and LaTex documentation for details on how to represent
|
||||||
and LaTex documentation for details on how to represent formulas and
|
formulas and escape special characters.</li>
|
||||||
escape special characters.</li>
|
|
||||||
<li>
|
<li>
|
||||||
Implementations <i>should</i> use standard algorithms and
|
Implementations <i>should</i> use standard algorithms and
|
||||||
references or full descriptions of all algorithms <i>should</i> be
|
references or full descriptions of all algorithms <i>should</i> be
|
||||||
|
|
Loading…
Reference in New Issue