Fixed JavaDoc "error" failures.

core/src/main/java/org/bouncycastle/asn1/ASN1Boolean.java

@@ -14,7 +14,6 @@
  * <li> {@link ASN1Boolean#getInstance(boolean) ASN1Boolean.getInstance(boolean)}</li>
  * <li> {@link ASN1Boolean#getInstance(int) ASN1Boolean.getInstance(int)}</li>
  * </ul>
- * </p>
  */
 public class ASN1Boolean
     extends ASN1Primitive

core/src/main/java/org/bouncycastle/asn1/ASN1Choice.java

@@ -15,11 +15,11 @@
  * The encoding of a choice value shall be the same as the encoding of a value of the chosen type.
  * <blockquote>
  * NOTE 1 &mdash; The encoding may be primitive or constructed depending on the chosen type.
- * <br />
+ * </blockquote>
+ * <blockquote>
  * NOTE 2 &mdash; The tag used in the identifier octets is the tag of the chosen type,
  * as specified in the ASN.1 definition of the choice type.
  * </blockquote>
- * </p>
  */
 public interface ASN1Choice
 {

core/src/main/java/org/bouncycastle/asn1/ASN1GeneralizedTime.java

@@ -28,6 +28,7 @@
  *
  * <h3>11: Restrictions on BER employed by both CER and DER</h3>
  * <h4>11.7 GeneralizedTime </h4>
+ * <p>
  * <b>11.7.1</b> The encoding shall terminate with a "Z",
  * as described in the ITU-T Rec. X.680 | ISO/IEC 8824-1 clause on
  * GeneralizedTime.
@@ -39,7 +40,6 @@
  * shall omit all trailing zeros; if the elements correspond to 0,
  * they shall be wholly omitted, and the decimal point element also
  * shall be omitted.
- * </p>
  */
 public class ASN1GeneralizedTime
     extends ASN1Primitive
@@ -185,7 +185,6 @@ public String getTimeString()
      * </pre>
      * To read in the time and get a date which is compatible with our local
      * time zone.
-     * </p>
      * @return a String representation of the time.
      */
     public String getTime()

core/src/main/java/org/bouncycastle/asn1/ASN1Integer.java

@@ -102,7 +102,7 @@ public ASN1Integer(
      * It has turned out that there are still a few applications that struggle with
      * the ASN.1 BER encoding rules for an INTEGER as described in:
      *
-     * @link https://www.itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf
+     * https://www.itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf
      * Section 8.3.2.
      * </p>
      * <p>

core/src/main/java/org/bouncycastle/asn1/ASN1Null.java

@@ -17,7 +17,6 @@ public abstract class ASN1Null
      * <li> {@link ASN1Null} object
      * <li> a byte[] containing ASN.1 NULL object
      * </ul>
-     * </p>
      *
      * @param o object to be converted.
      * @return an instance of ASN1Null, or null.

core/src/main/java/org/bouncycastle/asn1/ASN1OctetString.java

@@ -37,36 +37,36 @@
  * <p>
  * <b>8.7.3</b> The contents octets for the constructed encoding shall consist
  * of zero, one, or more encodings.
+ * </p>
  * <blockquote>
  * NOTE &mdash; Each such encoding includes identifier, length, and contents octets,
  * and may include end-of-contents octets if it is constructed.
  * </blockquote>
- * </p>
  * <p>
  * <b>8.7.3.1</b> To encode an octetstring value in this way,
  * it is segmented. Each segment shall consist of a series of
  * consecutive octets of the value. There shall be no significance
- * placed on the segment boundaries.
+ * placed on the segment boundaries.</p>
  * <blockquote>
  * NOTE &mdash; A segment may be of size zero, i.e. contain no octets.
  * </blockquote>
- * </p>
  * <p>
  * <b>8.7.3.2</b> Each encoding in the contents octets shall represent
  * a segment of the overall octetstring, the encoding arising from
  * a recursive application of this subclause.
  * In this recursive application, each segment is treated as if it were
  * a octetstring value. The encodings of the segments shall appear in the contents
  * octets in the order in which their octets appear in the overall value.
+ * </p>
  * <blockquote>
  * NOTE 1 &mdash; As a consequence of this recursion,
  * each encoding in the contents octets may itself
  * be primitive or constructed.
  * However, such encodings will usually be primitive.
- * <br />
+ * </blockquote>
+ * <blockquote>
  * NOTE 2 &mdash; In particular, the tags in the contents octets are always universal class, number 4.
  * </blockquote>
- * </p>
  * <p><b>9: Canonical encoding rules</b></p>
  * <p><b>9.1 Length forms</b></p>
  * <p>
@@ -95,7 +95,6 @@
  * For BIT STRING, OCTET STRING and restricted character string types,
  * the constructed form of encoding shall not be used.
  * (Contrast with 8.21.6.)
- * </p>
  */
 public abstract class ASN1OctetString
     extends ASN1Primitive

core/src/main/java/org/bouncycastle/asn1/ASN1Set.java

@@ -37,6 +37,7 @@
  * and places no constraints on the order during transfer
  * </blockquote>
  * <h4>8.12 Encoding of a set-of value</h4>
+ * <p>
  * <b>8.12.1</b> The encoding of a set-of value shall be constructed.
  * </p><p>
  * <b>8.12.2</b> The text of 8.10.2 applies:
@@ -83,7 +84,7 @@
  * an encoding for any component value which is equal to
  * its default value.
  * <h4>11.6 Set-of components </h4>
- * </p><p>
+ * <p>
  * The encodings of the component values of a set-of value
  * shall appear in ascending order, the encodings being compared
  * as octet strings with the shorter components being padded at
@@ -92,7 +93,6 @@
  * NOTE &mdash; The padding octets are for comparison purposes only
  * and do not appear in the encodings.
  * </blockquote>
- * </p>
  */
 public abstract class ASN1Set
     extends ASN1Primitive

core/src/main/java/org/bouncycastle/asn1/DERExternal.java

@@ -24,7 +24,6 @@ public class DERExternal
      * <li> {@link ASN1Integer} + data {@link DERTaggedObject} (indirect reference form)</li>
      * <li> Anything but {@link DERTaggedObject} + data {@link DERTaggedObject} (data value form)</li>
      * </ul>
-     * </p>
      *
      * @throws IllegalArgumentException if input size is wrong, or
      */

core/src/main/java/org/bouncycastle/asn1/DERPrintableString.java

@@ -9,7 +9,7 @@
  * DER PrintableString object.
  * <p>
  * X.680 section 37.4 defines PrintableString character codes as ASCII subset of following characters:
- * </p><p>
+ * </p>
  * <ul>
  * <li>Latin capital letters: 'A' .. 'Z'</li>
  * <li>Latin small letters: 'a' .. 'z'</li>
@@ -27,7 +27,7 @@
  * <li>Equals sign: '='</li>
  * <li>Question mark: '?'</li>
  * </ul>
- * </p><p>
+ * <p>
  * Explicit character set escape sequences are not allowed.
  * </p>
  */

core/src/main/java/org/bouncycastle/asn1/x9/DomainParameters.java

@@ -19,7 +19,7 @@
  *       p                INTEGER,           -- odd prime, p=jq +1
  *       g                INTEGER,           -- generator, g
  *       q                INTEGER,           -- factor of p-1
- *       j                INTEGER OPTIONAL,  -- subgroup factor, j>= 2
+ *       j                INTEGER OPTIONAL,  -- subgroup factor, j >= 2
  *       validationParams  ValidationParams OPTIONAL
  *    }
  * </pre>

core/src/main/java/org/bouncycastle/crypto/MacDerivationFunction.java

@@ -8,6 +8,8 @@ public interface MacDerivationFunction
 {
     /**
      * return the MAC used as the basis for the function
+     *
+     * @return the Mac.
      */
     public Mac getMac();
 }

core/src/main/java/org/bouncycastle/crypto/generators/BCrypt.java

@@ -13,8 +13,8 @@
  * "A Future-Adaptable Password Scheme" of Niels Provos and David Mazières,
  * see: https://www.usenix.org/legacy/events/usenix99/provos/provos_html/node1.html.
  * In contrast to the paper, the order of key setup and salt setup is reversed:
- * state <- ExpandKey(state, 0, key)
- * state <- ExpandKey(state, 0, salt)
+ * state &lt;- ExpandKey(state, 0, key)
+ * state &lt;- ExpandKey(state, 0, salt)
  * This corresponds to the OpenBSD reference implementation of Bcrypt. 
  * </p><p>
  * Note: 

core/src/main/java/org/bouncycastle/crypto/generators/CramerShoupParametersGenerator.java

@@ -38,6 +38,7 @@ public void init(int size, int certainty, SecureRandom random)
      * <p>
      * Note: can take a while...
      * </p>
+     * @return a generated CramerShoupParameters object.
      */
     public CramerShoupParameters generateParameters()
     {

core/src/main/java/org/bouncycastle/crypto/generators/DHParametersGenerator.java

@@ -1,10 +1,10 @@
 package org.bouncycastle.crypto.generators;
 
-import org.bouncycastle.crypto.params.DHParameters;
-
 import java.math.BigInteger;
 import java.security.SecureRandom;
 
+import org.bouncycastle.crypto.params.DHParameters;
+
 public class DHParametersGenerator
 {
     private int             size;
@@ -35,6 +35,7 @@ public void init(
      * returning the DHParameters object.
      * <p>
      * Note: can take a while...
+     * @return a generated Diffie-Hellman parameters object.
      */
     public DHParameters generateParameters()
     {

core/src/main/java/org/bouncycastle/crypto/generators/DSAParametersGenerator.java

@@ -110,6 +110,7 @@ else if (L == 3072 && N != 256)
      * returning the DSAParameters object.
      * <p>
      * Note: can take a while...
+     * @return a generated DSA parameters object.
      */
     public DSAParameters generateParameters()
     {

core/src/main/java/org/bouncycastle/crypto/generators/ElGamalParametersGenerator.java

@@ -1,10 +1,10 @@
 package org.bouncycastle.crypto.generators;
 
-import org.bouncycastle.crypto.params.ElGamalParameters;
-
 import java.math.BigInteger;
 import java.security.SecureRandom;
 
+import org.bouncycastle.crypto.params.ElGamalParameters;
+
 public class ElGamalParametersGenerator
 {
     private int             size;
@@ -26,6 +26,8 @@ public void init(
      * returning the ElGamalParameters object.
      * <p>
      * Note: can take a while...
+     *
+     * @return a generated ElGamal parameters object.
      */
     public ElGamalParameters generateParameters()
     {

core/src/main/java/org/bouncycastle/crypto/generators/GOST3410ParametersGenerator.java

@@ -1,11 +1,11 @@
 package org.bouncycastle.crypto.generators;
 
-import org.bouncycastle.crypto.params.GOST3410Parameters;
-import org.bouncycastle.crypto.params.GOST3410ValidationParameters;
-
 import java.math.BigInteger;
 import java.security.SecureRandom;
 
+import org.bouncycastle.crypto.params.GOST3410Parameters;
+import org.bouncycastle.crypto.params.GOST3410ValidationParameters;
+
 /**
  * generate suitable parameters for GOST3410.
  */
@@ -453,7 +453,7 @@ private void procedure_Bb(long x0, long c, BigInteger[] pq)
     }
 
 
-    /**
+    /*
      * Procedure C
      * procedure generates the a value from the given p,q,
      * returning the a value.
@@ -484,6 +484,8 @@ private BigInteger procedure_C(BigInteger p, BigInteger q)
     /**
      * which generates the p , q and a values from the given parameters,
      * returning the GOST3410Parameters object.
+     *
+     * @return a generated GOST3410 parameters object.
      */
     public GOST3410Parameters generateParameters()
     {

core/src/main/java/org/bouncycastle/crypto/generators/KDFCounterBytesGenerator.java

@@ -20,14 +20,13 @@
  * <li>3b: K(i) := PRF( KI, Label || 0x00 || [i]_2 || [L]_2 || Context ) OR:</li>
  * <li>3c: K(i) := PRF( KI, Label || [i]_2 || 0x00 || Context || [L]_2 ) etc... with the counter somewhere in the 'middle' of the fixedInputData.</li>
  * </ul>
- * </p>
- * <p>
  * This function must be called with the following KDFCounterParameters():
- *  - KI      <br/>
- *  - The part of the fixedInputData that comes BEFORE the counter OR null  <br/>
- *  - the part of the fixedInputData that comes AFTER the counter OR null <br/>
- *  - the length of the counter in bits (not bytes)
- *  </p>
+ * <ul>
+ *  <li>KI</li>
+ *  <li>The part of the fixedInputData that comes BEFORE the counter OR null</li>
+ *  <li>the part of the fixedInputData that comes AFTER the counter OR null </li>
+ *  <li>the length of the counter in bits (not bytes)</li>
+ * </ul>
  * Resulting function calls assuming an 8 bit counter.
  * <ul>
  * <li>1.  KDFCounterParameters(ki, 	null, 									"Label || 0x00 || Context || [L]_2]",	8);</li>

core/src/main/java/org/bouncycastle/crypto/generators/SCrypt.java

@@ -23,7 +23,7 @@ public class SCrypt
      * @param S the salt to use for this invocation.
      * @param N CPU/Memory cost parameter. Must be larger than 1, a power of 2 and less than
      *            <code>2^(128 * r / 8)</code>.
-     * @param r the block size, must be >= 1.
+     * @param r the block size, must be &gt;= 1.
      * @param p Parallelization parameter. Must be a positive integer less than or equal to
      *            <code>Integer.MAX_VALUE / (128 * r * 8)</code>.
      * 

core/src/main/java/org/bouncycastle/crypto/params/KDFCounterParameters.java

@@ -14,13 +14,13 @@
  * <li>3b: K(i) := PRF( KI, Label || 0x00 || [i]_2 || [L]_2 || Context ) OR:</li>
  * <li>3c: K(i) := PRF( KI, Label || [i]_2 || 0x00 || Context || [L]_2 ) etc... with the counter somewhere in the 'middle' of the fixedInputData.</li>
  * </ul>
- * <p>
  * This function must be called with the following KDFCounterParameters():
- *  - KI     <br/>
- *  - The part of the fixedInputData that comes BEFORE the counter OR null  <br/>
- *  - the part of the fixedInputData that comes AFTER the counter OR null  <br/>
- *  - the length of the counter in bits (not bytes) <br/>
- * </p>
+ * <ul>
+ *  <li>KI</li>
+ *  <li>The part of the fixedInputData that comes BEFORE the counter OR null</li>
+ *  <li>the part of the fixedInputData that comes AFTER the counter OR null</li>
+ *  <li>the length of the counter in bits (not bytes)</li>
+ *  </ul>
  * Resulting function calls assuming an 8 bit counter.
  * <ul>
  * <li>1.  KDFCounterParameters(ki, 	null, 									"Label || 0x00 || Context || [L]_2]",	8); </li>

core/src/main/java/org/bouncycastle/crypto/tls/TlsClient.java

@@ -23,7 +23,7 @@ public interface TlsClient
     TlsSession getSessionToResume();
 
     /**
-     * Return the {@link ProtocolVersion} to use for the <c>TLSPlaintext.version</c> field prior to
+     * Return the {@link ProtocolVersion} to use for the <code>TLSPlaintext.version</code> field prior to
      * receiving the server version. NOTE: This method is <b>not</b> called for DTLS.
      *
      * <p>

core/src/main/java/org/bouncycastle/crypto/tls/TlsClientProtocol.java

@@ -39,7 +39,7 @@ public TlsClientProtocol(InputStream input, OutputStream output, SecureRandom se
     /**
      * Constructor for non-blocking mode.<br>
      * <br>
-     * When data is received, use {@link #offerInput(java.nio.ByteBuffer)} to
+     * When data is received, use offerInput(java.nio.ByteBuffer) to
      * provide the received ciphertext, then use
      * {@link #readInput(byte[], int, int)} to read the corresponding cleartext.<br>
      * <br>

core/src/main/java/org/bouncycastle/crypto/tls/TlsServerProtocol.java

@@ -39,7 +39,7 @@ public TlsServerProtocol(InputStream input, OutputStream output, SecureRandom se
     /**
      * Constructor for non-blocking mode.<br>
      * <br>
-     * When data is received, use {@link #offerInput(java.nio.ByteBuffer)} to
+     * When data is received, use offerInput(java.nio.ByteBuffer) to
      * provide the received ciphertext, then use
      * {@link #readInput(byte[], int, int)} to read the corresponding cleartext.<br>
      * <br>

core/src/main/java/org/bouncycastle/math/ec/ECPoint.java

@@ -440,6 +440,7 @@ public String toString()
 
     /**
      * @deprecated per-point compression property will be removed, refer {@link #getEncoded(boolean)}
+     * @return a byte encoding.
      */
     public byte[] getEncoded()
     {

core/src/main/java/org/bouncycastle/pqc/asn1/McElieceCCA2PrivateKey.java

@@ -19,6 +19,7 @@
  * Return the keyData to encode in the PrivateKeyInfo structure.
  * <p>
  * The ASN.1 definition of the key structure is
+ * </p>
  * <pre>
  *   McElieceCCA2PrivateKey ::= SEQUENCE {
  *     m             INTEGER                  -- extension degree of the field
@@ -29,7 +30,6 @@
  *     digest        AlgorithmIdentifier      -- algorithm identifier for CCA2 digest
  *   }
  * </pre>
- * </p>
  */
 public class McElieceCCA2PrivateKey
     extends ASN1Object