[ISSUE #310] Fix to successfully generate java doc (#311)

* fix(core): remove unused param

1. remove unused param

* fix(core): fix comments to pass generating java doc

1. fix comments to pass generating java doc

Author: TheR1sing3un

dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerEntryPusher.java

@@ -192,6 +192,7 @@ public void wakeUpDispatchers() {
      * Complete the TimeoutFuture in pendingAppendResponsesByTerm (CurrentTerm, index).
      * Called by statemachineCaller when a committed entry (CurrentTerm, index) was applying to statemachine done.
      *
+     * @param task committed entry
      * @return true if complete success
      */
     public boolean completeResponseFuture(final ApplyEntry task) {
@@ -215,6 +216,8 @@ public boolean completeResponseFuture(final ApplyEntry task) {
 
     /**
      * Check responseFutures timeout from {beginIndex} in currentTerm
+     *
+     * @param beginIndex the beginning index to check
      */
     public void checkResponseFuturesTimeout(final long beginIndex) {
         final long term = this.memberState.currTerm();

dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerRpcNettyService.java

@@ -367,10 +367,6 @@ private void writeResponse(RequestOrResponse storeResp, Throwable t, RemotingCom
      * CompletableFuture is an excellent choice, whenCompleteAsync will handle the response asynchronously. With an
      * independent thread-pool, it will improve performance and reduce blocking points.
      *
-     * @param ctx
-     * @param request
-     * @return
-     * @throws Exception
      */
     public RemotingCommand processRequest(ChannelHandlerContext ctx, RemotingCommand request) throws Exception {
         DLedgerRequestCode requestCode = DLedgerRequestCode.valueOf(request.getCode());

dledger/src/main/java/io/openmessaging/storage/dledger/DLedgerServer.java

@@ -291,10 +291,6 @@ public CompletableFuture<VoteResponse> handleVote(VoteRequest request) throws Ex
     /**
      * Handle the append requests: 1.append the entry to local store 2.submit the future to entry pusher and wait the
      * quorum ack 3.if the pending requests are full, then reject it immediately
-     *
-     * @param request
-     * @return
-     * @throws IOException
      */
     @Override
     public CompletableFuture<AppendEntryResponse> handleAppend(AppendEntryRequest request) throws IOException {

dledger/src/main/java/io/openmessaging/storage/dledger/MemberState.java

@@ -275,9 +275,11 @@ public long getCommittedIndex() {
 
     /**
      * update committedIndex
+     *
      * @param term term of the entry which is committed. Very importantly, we can only commit the entry with current term, which also means that
      *             we can't commit the entry with old term.
      * @param committedIndex the index of the entry which is committed.
+     * @return true if the committedIndex is updated, otherwise false.
      */
     public boolean leaderUpdateCommittedIndex(long term, long committedIndex) {
         if (!this.isLeader()) return false;

dledger/src/main/java/io/openmessaging/storage/dledger/common/WriteClosure.java

@@ -19,5 +19,5 @@
 public abstract class WriteClosure<T> extends Closure {
     public abstract void setResp(T t);
 
-    public abstract T getResp(T t);
+    public abstract T getResp();
 }

dledger/src/main/java/io/openmessaging/storage/dledger/snapshot/SnapshotManager.java

@@ -40,7 +40,7 @@
 import java.util.concurrent.CompletableFuture;
 
 /**
- * <h>snapshot dir tree (here is an example)</h>
+ * snapshot dir tree (here is an example)
  * <pre>
  *   snapshot
  *     - tmp  (saving snapshot now, but has not been renamed to a snapshot dir)

dledger/src/main/java/io/openmessaging/storage/dledger/statemachine/StateMachine.java

@@ -38,6 +38,7 @@ public interface StateMachine {
      * User defined snapshot generate function.
      *
      * @param writer snapshot writer
+     * @return true on success
      */
     boolean onSnapshotSave(final SnapshotWriter writer);
 

dledger/src/main/java/io/openmessaging/storage/dledger/store/file/MmapFile.java

@@ -242,10 +242,10 @@ public interface MmapFile {
     /**
      * get the data from file channel
      *
-     * @param pos
-     * @param size
-     * @param byteBuffer
-     * @return
+     * @param pos the start position of the data
+     * @param size the size of the data
+     * @param byteBuffer the buffer to store the data
+     * @return true if success; false otherwise.
      */
     boolean getData(int pos, int size, ByteBuffer byteBuffer);
 }

dledger/src/test/java/io/openmessaging/storage/dledger/WriteTest.java

@@ -43,7 +43,7 @@ public void setResp(Long aLong) {
         }
 
         @Override
-        public Long getResp(Long aLong) {
+        public Long getResp() {
             return totalEntries;
         }
     }

dledger/src/test/java/io/openmessaging/storage/dledger/statemachine/StateMachineCallerTest.java

@@ -203,7 +203,7 @@ public void setResp(Object o) {
                 }
 
                 @Override
-                public Object getResp(Object o) {
+                public Object getResp() {
                     return totalEntries;
                 }