Merge pull request #27 from str4d/26-mathjax

Render all maths with MathJax

Author: str4d

pom.xml

@@ -97,15 +97,23 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
         <version>2.9.1</version>
+        <configuration>
+          <header>&lt;script type='text/x-mathjax-config'&gt;
+  MathJax.Hub.Config({
+    tex2jax: {
+      inlineMath: [ ['$','$'] ],
+      processEscapes: true
+    }
+  });
+&lt;/script&gt;
+&lt;script type='text/javascript' src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'&gt;&lt;/script&gt;</header>
+        </configuration>
         <executions>
           <execution>
             <id>attach-javadocs</id>
             <goals>
               <goal>jar</goal>
             </goals>
-            <configuration> <!-- There are some malformed javadoc comments -->
-                <failOnError>false</failOnError>
-            </configuration>
           </execution>
         </executions>
       </plugin>

src/net/i2p/crypto/eddsa/math/Curve.java

@@ -15,7 +15,7 @@
 
 /**
  * A twisted Edwards curve.
- * Points on the curve satisfy -x^2 + y^2 = 1 + d x^2y^2
+ * Points on the curve satisfy $-x^2 + y^2 = 1 + d x^2y^2$
  * @author str4d
  *
  */

src/net/i2p/crypto/eddsa/math/Encoding.java

@@ -12,7 +12,7 @@
 package net.i2p.crypto.eddsa.math;
 
 /**
- * Common interface for all (b-1)-bit encodings of elements
+ * Common interface for all $(b-1)$-bit encodings of elements
  * of EdDSA finite fields.
  * @author str4d
  *
@@ -27,25 +27,25 @@ public synchronized void setField(Field f) {
     }
 
     /**
-     * Encode a FieldElement in its (b-1)-bit encoding.
-     * @return the (b-1)-bit encoding of this FieldElement.
+     * Encode a FieldElement in its $(b-1)$-bit encoding.
+     * @return the $(b-1)$-bit encoding of this FieldElement.
      */
     public abstract byte[] encode(FieldElement x);
 
     /**
-     * Decode a FieldElement from its (b-1)-bit encoding.
+     * Decode a FieldElement from its $(b-1)$-bit encoding.
      * The highest bit is masked out.
-     * @param in the (b-1)-bit encoding of a FieldElement.
+     * @param in the $(b-1)$-bit encoding of a FieldElement.
      * @return the FieldElement represented by 'val'.
      */
     public abstract FieldElement decode(byte[] in);
 
     /**
      * From the Ed25519 paper:<br>
-     * x is negative if the (b-1)-bit encoding of x is lexicographically larger
-     * than the (b-1)-bit encoding of -x. If q is an odd prime and the encoding
-     * is the little-endian representation of {0, 1,..., q-1} then the negative
-     * elements of F_q are {1, 3, 5,..., q-2}.
+     * $x$ is negative if the $(b-1)$-bit encoding of $x$ is lexicographically larger
+     * than the $(b-1)$-bit encoding of -x. If $q$ is an odd prime and the encoding
+     * is the little-endian representation of $\{0, 1,\dots, q-1\}$ then the negative
+     * elements of $F_q$ are $\{1, 3, 5,\dots, q-2\}$.
      * @return true if negative
      */
     public abstract boolean isNegative(FieldElement x);

src/net/i2p/crypto/eddsa/math/FieldElement.java

@@ -29,8 +29,8 @@ public FieldElement(Field f) {
     }
 
     /**
-     * Encode a FieldElement in its (b-1)-bit encoding.
-     * @return the (b-1)-bit encoding of this FieldElement.
+     * Encode a FieldElement in its $(b-1)$-bit encoding.
+     * @return the $(b-1)$-bit encoding of this FieldElement.
      */
     public byte[] toByteArray() {
         return f.getEncoding().encode(this);