From dfed9e5f4a679fc05d07ae181b847dae9ed04d77 Mon Sep 17 00:00:00 2001 From: Roberto Saltini <38655434+saltiniroberto@users.noreply.github.com> Date: Fri, 26 Oct 2018 11:28:00 +1100 Subject: [PATCH] Fixed javadoc warnings (#159) --- .../ibft/ibftmessagedata/IbftUnsignedPrepareMessageData.java | 1 - .../ibftmessagedata/IbftUnsignedRoundChangeMessageData.java | 1 - .../pantheon/consensus/ibft/protocol/IbftProtocolManager.java | 2 +- .../main/java/tech/pegasys/pantheon/ethereum/core/Util.java | 4 ++++ 4 files changed, 5 insertions(+), 3 deletions(-) diff --git a/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/ibftmessagedata/IbftUnsignedPrepareMessageData.java b/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/ibftmessagedata/IbftUnsignedPrepareMessageData.java index ef32262f4e..6d28cf270d 100644 --- a/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/ibftmessagedata/IbftUnsignedPrepareMessageData.java +++ b/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/ibftmessagedata/IbftUnsignedPrepareMessageData.java @@ -22,7 +22,6 @@ public class IbftUnsignedPrepareMessageData extends AbstractIbftUnsignedInRoundM private static final int TYPE = IbftV2.PREPARE; private final Hash digest; - /** Constructor used when a validator wants to send a message */ public IbftUnsignedPrepareMessageData( final ConsensusRoundIdentifier roundIdentifier, final Hash digest) { super(roundIdentifier); diff --git a/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/ibftmessagedata/IbftUnsignedRoundChangeMessageData.java b/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/ibftmessagedata/IbftUnsignedRoundChangeMessageData.java index d132dc83e0..5701cc9eb4 100644 --- a/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/ibftmessagedata/IbftUnsignedRoundChangeMessageData.java +++ b/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/ibftmessagedata/IbftUnsignedRoundChangeMessageData.java @@ -29,7 +29,6 @@ public class IbftUnsignedRoundChangeMessageData extends AbstractIbftUnsignedMess // The validator may not hae any prepared certificate private final Optional preparedCertificate; - /** Constructor used only by the {@link #readFrom(RLPInput)} method */ public IbftUnsignedRoundChangeMessageData( final ConsensusRoundIdentifier roundIdentifier, final Optional preparedCertificate) { diff --git a/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/protocol/IbftProtocolManager.java b/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/protocol/IbftProtocolManager.java index b9e3db317e..70b42d8c25 100644 --- a/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/protocol/IbftProtocolManager.java +++ b/consensus/ibft/src/main/java/tech/pegasys/pantheon/consensus/ibft/protocol/IbftProtocolManager.java @@ -38,7 +38,7 @@ public class IbftProtocolManager implements ProtocolManager { * Constructor for the ibft protocol manager * * @param ibftEventQueue Entry point into the ibft event processor - * @param peers + * @param peers iBFT network peers */ public IbftProtocolManager(final IbftEventQueue ibftEventQueue, final IbftNetworkPeers peers) { this.ibftEventQueue = ibftEventQueue; diff --git a/ethereum/core/src/main/java/tech/pegasys/pantheon/ethereum/core/Util.java b/ethereum/core/src/main/java/tech/pegasys/pantheon/ethereum/core/Util.java index 4ab9578c71..6a4cb11767 100644 --- a/ethereum/core/src/main/java/tech/pegasys/pantheon/ethereum/core/Util.java +++ b/ethereum/core/src/main/java/tech/pegasys/pantheon/ethereum/core/Util.java @@ -38,6 +38,10 @@ public class Util { /** * Implements a fast version of ceiling(numerator/denominator) that does not require using * floating point math + * + * @param numerator Numerator + * @param denominator Denominator + * @return result of ceiling(numerator/denominator) */ public static int fastDivCeiling(final int numerator, final int denominator) { return ((numerator - 1) / denominator) + 1;