update doc for addWriteCursorLedgerSize

apache · Aug 10, 2021 · 664539d · 664539d
1 parent 105ae9c
commit 664539d
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/managed-ledger/src/main/java/org/apache/bookkeeper/mledger/ManagedCursorMXBean.java b/managed-ledger/src/main/java/org/apache/bookkeeper/mledger/ManagedCursorMXBean.java
@@ -39,13 +39,14 @@ public interface ManagedCursorMXBean {
     String getLedgerName();
 
     /**
-     * persist cursor by ledger
+     * persist cursor by ledger.
+     *
      * @param success
      */
     void persistToLedger(boolean success);
 
     /**
-     * persist cursor by zookeeper
+     * persist cursor by zookeeper.
      * @param success
      */
     void persistToZookeeper(boolean success);
@@ -72,7 +73,7 @@ public interface ManagedCursorMXBean {
 
     /**
      * Add write data to a ledger of a cursor (in bytes).
-     *
+     * This will update writeCursorLedgerLogicalSize and writeCursorLedgerSize.
      * @param size Size of data written to cursor (in bytes)
      */
     void addWriteCursorLedgerSize(long size);