Javadoc

Signed-off-by: Matthew Whitehead <matthew1001@gmail.com>
hyperledger · Feb 27, 2025 · 881d371 · 881d371
1 parent 05e28fc
commit 881d371
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/...c/main/java/org/hyperledger/besu/consensus/common/bft/statemachine/BaseBftController.java b/...c/main/java/org/hyperledger/besu/consensus/common/bft/statemachine/BaseBftController.java
@@ -220,7 +220,11 @@ public void handleRoundExpiry(final RoundExpiry roundExpiry) {
    */
   protected abstract BaseBlockHeightManager getCurrentHeightManager();
 
-  /** Replaces the current height manager with a no-op height manager. */
+  /**
+   * Stop the current height manager by creating a no-op block height manager.
+   *
+   * @param parentHeader the parent header
+   */
   protected abstract void stopCurrentHeightManager(final BlockHeader parentHeader);
 
   private void startNewHeightManager(final BlockHeader parentHeader) {

diff --git a/.../java/org/hyperledger/besu/consensus/ibft/statemachine/IbftBlockHeightManagerFactory.java b/.../java/org/hyperledger/besu/consensus/ibft/statemachine/IbftBlockHeightManagerFactory.java
@@ -68,6 +68,12 @@ public BaseIbftBlockHeightManager create(final BlockHeader parentHeader) {
     }
   }
 
+  /**
+   * Create a no-op block height manager.
+   *
+   * @param parentHeader the parent header
+   * @return the no-op height manager
+   */
   protected BaseIbftBlockHeightManager createNoOpBlockHeightManager(
       final BlockHeader parentHeader) {
     return new NoOpBlockHeightManager(parentHeader);