Fix JavaDoc errors due to invalid HTML on JDK 11. (#160)

ethereum/core/src/main/java/tech/pegasys/pantheon/ethereum/core/Address.java

@@ -67,9 +67,8 @@ public class Address extends DelegatingBytesValue {
   }
 
   /**
-   * @param hash A hash that has been obtained through hashing the return of the
+   * @param hash A hash that has been obtained through hashing the return of the <code>ECDSARECOVER
-   *     <tt>ECDSARECOVER</tt> function from Appendix F (Signing Transactions) of the Ethereum
+   *     </code> function from Appendix F (Signing Transactions) of the Ethereum Yellow Paper.
-   *     Yellow Paper.
    * @return The ethereum address from the provided hash.
    */
   public static Address extract(final Hash hash) {

ethereum/core/src/main/java/tech/pegasys/pantheon/ethereum/mainnet/AbstractMessageProcessor.java

@@ -31,7 +31,8 @@ import java.util.stream.Collectors;
  * default behaviors. There is currently no method for responding to a {@link
  * MessageFrame.State#CODE_SUSPENDED}.
  *
- * <table summary="Method Overview">
+ * <table>
+ * <caption>Method Overview</caption>
  * <tr>
  * <td><b>{@code MessageFrame.State}</b></td>
  * <td><b>Method</b></td>

ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/discovery/PeerDiscoveryEvent.java

@@ -41,8 +41,8 @@ public abstract class PeerDiscoveryEvent {
   }
 
   /**
-   * An event that is dispatched whenever we bond with a new peer. See Javadoc on
+   * An event that is dispatched whenever we bond with a new peer. See Javadoc on <code>
-   * <tt>PeerDiscoveryController</tt> to understand when this happens.
+   * PeerDiscoveryController</code> to understand when this happens.
    *
    * <p>{@link tech.pegasys.pantheon.ethereum.p2p.discovery.internal.PeerDiscoveryController}
    */
@@ -53,8 +53,8 @@ public abstract class PeerDiscoveryEvent {
   }
 
   /**
-   * An event that is dispatched whenever we drop a peer from the peer table. See Javadoc on
+   * An event that is dispatched whenever we drop a peer from the peer table. See Javadoc on <code>
-   * <tt>PeerDiscoveryController</tt> to understand when this happens.
+   * PeerDiscoveryController</code> to understand when this happens.
    *
    * <p>{@link tech.pegasys.pantheon.ethereum.p2p.discovery.internal.PeerDiscoveryController}
    */

ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/discovery/internal/Bucket.java

@@ -110,7 +110,7 @@ public class Bucket {
    * the left (subtracts one from their indices).
    *
    * @param peer the element to be removed
-   * @return <tt>true</tt>
+   * @return <code>true</code>
    */
   synchronized boolean evict(final PeerId peer) {
     // If the bucket is empty, there's nothing to evict.

ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/discovery/internal/PeerDiscoveryController.java

@@ -81,10 +81,10 @@ import org.apache.logging.log4j.Logger;
  *   <li><em>DROPPED (*):</em> the peer is no longer in our peer table.
  * </ul>
  *
- * <p>(*) It is worthy to note that the <tt>MESSAGE_EXPECTED</tt> and <tt>DROPPED</tt> states are
+ * <p>(*) It is worthy to note that the <code>MESSAGE_EXPECTED</code> and <code>DROPPED</code>
- * not modelled explicitly in {@link PeerDiscoveryStatus}, but they have been included in the
+ * states are not modelled explicitly in {@link PeerDiscoveryStatus}, but they have been included in
- * diagram for clarity. These two states define the elimination path for a peer from the underlying
+ * the diagram for clarity. These two states define the elimination path for a peer from the
- * table.
+ * underlying table.
  *
  * <p>If an expectation to receive a message was unmet, following the evaluation of a failure
  * condition, the peer will be physically dropped (eliminated) from the table.

ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/discovery/internal/PeerTable.java

@@ -169,12 +169,12 @@ public class PeerTable {
   }
 
   /**
-   * Returns the <tt>limit</tt> peers (at most) closest to the provided target, based on the XOR
+   * Returns the <code>limit</code> peers (at most) closest to the provided target, based on the XOR
    * distance between the keccak-256 hash of the ID and the keccak-256 hash of the target.
    *
    * @param target The target node ID.
    * @param limit The amount of results to return.
-   * @return The <tt>limit</tt> closest peers, at most.
+   * @return The <code>limit</code> closest peers, at most.
    */
   public List<DiscoveryPeer> nearestPeers(final BytesValue target, final int limit) {
     final BytesValue keccak256 = Hash.keccak256(target);

ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/rlpx/framing/Framer.java

@@ -111,12 +111,12 @@ public class Framer {
    * Deframes a full message from the byte buffer, if possible.
    *
    * <p>If the byte buffer contains insufficient bytes to extract a full message, this method
-   * returns <tt>null</tt>.
+   * returns <code>null</code>.
    *
    * <p>If the buffer contains at least a header, it offloads it and processes it, setting an
    * internal expectation to subsequently receive as many bytes for the frame as the header
-   * specified. In this case, this method also returns <tt>null</tt> to inform the caller that it
+   * specified. In this case, this method also returns <code>null</code> to inform the caller that
-   * requires more bytes before it can produce an output.
+   * it requires more bytes before it can produce an output.
    *
    * <p>This method can be called repetitively whenever new bytes appear in the buffer. It is worthy
    * to note that the byte buffer is not consumed unless the next expected amount of bytes appears.
@@ -129,7 +129,7 @@ public class Framer {
    * connection, as the digests and stream ciphers could have become corrupted.
    *
    * @param buf The buffer containing no messages, partial messages or multiple messages.
-   * @return The first fully extracted message from this buffer, or <tt>null</tt> if no message
+   * @return The first fully extracted message from this buffer, or <code>null</code> if no message
    *     could be extracted yet.
    * @throws FramingException Thrown when a decryption or internal error occurs.
    */

ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/rlpx/handshake/Handshaker.java

@@ -71,7 +71,7 @@ public interface Handshaker {
    * This method must be called by the <em>initiating side</em> of the handshake to provide the
    * initial crypto material for the handshake, before any further methods are called.
    *
-   * <p>This method must throw an <tt>IllegalStateException</tt> exception if the handshake had
+   * <p>This method must throw an {@link IllegalStateException} exception if the handshake had
    * already been prepared before, no matter if under the initiator or the responder role.
    *
    * @param ourKeypair The keypair for our node identity.
@@ -84,7 +84,7 @@ public interface Handshaker {
    * This method must be called by the <em>responding side</em> of the handshake to prepare the
    * initial crypto material for the handshake, before any further methods are called.
    *
-   * <p>This method must throw an <tt>IllegalStateException</tt> exception if the handshake had
+   * <p>This method must throw an {@link IllegalStateException} exception if the handshake had
    * already been prepared before, whether with the initiator or the responder role.
    *
    * @param ourKeypair The keypair for our node identity.
@@ -100,7 +100,7 @@ public interface Handshaker {
    * the initiator is allowed to send the first message in the channel. Future implementations may
    * allow for a concurrent exchange.
    *
-   * <p>This method will throw an <tt>IllegalStateException</tt> if the consumer has prepared this
+   * <p>This method will throw an {@link IllegalStateException} if the consumer has prepared this
    * handshake taking the role of the responder, and the underlying implementation only allows the
    * initiator to send the first message.
    *

ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/rlpx/handshake/ecies/ECIESEncryptionEngine.java

@@ -50,8 +50,8 @@ import org.bouncycastle.util.Pack;
  * Scheme</a> engine that implements the encryption and decryption logic behind the ECIES crypto
  * handshake during the RLPx connection establishment.
  *
- * <p>This class has been inspired by the <tt>IESEngine</tt> implementation in Bouncy Castle. It has
+ * <p>This class has been inspired by the <code>IESEngine</code> implementation in Bouncy Castle. It
- * been modified heavily to accommodate our usage, yet the core logic remains unchanged. It
+ * has been modified heavily to accommodate our usage, yet the core logic remains unchanged. It
  * implements a peculiarity of the Ethereum encryption protocol: updating the encryption MAC with
  * the IV.
  */
@@ -341,8 +341,8 @@ public class ECIESEncryptionEngine {
    * Key generation function as defined in NIST SP 800-56A, but swapping the order of the digested
    * values (counter first, shared secret second) to comply with Ethereum's approach.
    *
-   * <p>This class has been adapted from the <tt>BaseKDFBytesGenerator</tt> implementation of Bouncy
+   * <p>This class has been adapted from the <code>BaseKDFBytesGenerator</code> implementation of
-   * Castle.
+   * Bouncy Castle.
    */
   private static class ECIESHandshakeKDFFunction implements DigestDerivationFunction {
     private static final int COUNTER_START = 1;
@@ -371,7 +371,7 @@ public class ECIESEncryptionEngine {
     }
 
     /**
-     * Fills <tt>len</tt> bytes of the output buffer with bytes generated from the derivation
+     * Fills <code>len</code> bytes of the output buffer with bytes generated from the derivation
      * function.
      *
      * @throws IllegalArgumentException If the size of the request will cause an overflow.

ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/rlpx/handshake/ecies/ECIESHandshaker.java

@@ -301,12 +301,14 @@ public class ECIESHandshaker implements Handshaker {
   /**
    * Returns the current status of this handshake.
    *
-   * <p>Starts <tt>UNINITIALIZED</tt> and moves to <tt>PREPARED</tt> when a prepared* method is
+   * <p>Starts {@link Handshaker.HandshakeStatus#UNINITIALIZED} and moves to {@link
-   * called, or to <tt>IN_PROGRESS</tt> if we're the responder part and have nothing to prepare
+   * Handshaker.HandshakeStatus#PREPARED} when a prepared* method is called, or to {@link
+   * Handshaker.HandshakeStatus#IN_PROGRESS} if we're the responder part and have nothing to prepare
    * since we're awaiting the initiator's message.
    *
-   * <p>As soon as we receive the expected message, the status transitions to <tt>SUCCESS</tt> if
+   * <p>As soon as we receive the expected message, the status transitions to {@link
-   * the message is well formed and we're able to generate the resulting secrets.
+   * Handshaker.HandshakeStatus#SUCCESS} if the message is well formed and we're able to generate
+   * the resulting secrets.
    *
    * @return Returns the current status of this handshake.
    */

ethereum/p2p/src/main/java/tech/pegasys/pantheon/ethereum/p2p/wire/PeerInfo.java

@@ -32,7 +32,7 @@ import io.netty.buffer.ByteBuf;
  * Encapsulates information about a peer, including their protocol version, client ID, capabilities
  * and other.
  *
- * <p>The peer info is shared between peers during the <tt>HELLO</tt> wire protocol handshake.
+ * <p>The peer info is shared between peers during the <code>HELLO</code> wire protocol handshake.
  */
 public class PeerInfo {
   private final int version;

ethereum/rlp/src/main/java/tech/pegasys/pantheon/ethereum/rlp/RLPInput.java

@@ -110,7 +110,8 @@ public interface RLPInput {
   /**
    * Exits the current list after all its items have been consumed.
    *
-   * <p>This method is equivalent to calling {@link #leaveList(boolean)} with value <tt>false</tt>.
+   * <p>This method is equivalent to calling {@link #leaveList(boolean)} with value <code>false
+   * </code>.
    *
    * <p>Note that this method technically doesn't consume any input but must be called after having
    * read the last element of a list. This allow to ensure the structure of the input is indeed the
@@ -128,9 +129,9 @@ public interface RLPInput {
    * one expected.
    *
    * @param ignoreRest Whether to ignore any remaining elements in the list. If elements remain and
-   *     this parameter is <tt>false</tt>, an exception will be thrown.
+   *     this parameter is <code>false</code>, an exception will be thrown.
-   * @throws RLPException if the current list is not finished (it has more items), if
+   * @throws RLPException if the current list is not finished (it has more items), if <code>
-   *     <tt>ignoreRest</tt> is <tt>false</tt>.
+   *     ignoreRest</code> is <code>false</code>.
    */
   void leaveList(boolean ignoreRest);