JavaDoc: Fix dangling comments.

nogang · Mar 11, 2018 · 326e076 · 326e076
1 parent df1b954
commit 326e076
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 40 deletions.
diff --git a/core/src/main/java/org/bitcoinj/core/FullPrunedBlockChain.java b/core/src/main/java/org/bitcoinj/core/FullPrunedBlockChain.java
@@ -341,10 +341,10 @@ protected TransactionOutputChanges connectTransactions(int height, Block block)
         return new TransactionOutputChanges(txOutsCreated, txOutsSpent);
     }
 
-    @Override
     /**
      * Used during reorgs to connect a block previously on a fork
      */
+    @Override
     protected synchronized TransactionOutputChanges connectTransactions(StoredBlock newBlock)
             throws VerificationException, BlockStoreException, PrunedException {
         checkState(lock.isHeldByCurrentThread());

diff --git a/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClientConnection.java b/core/src/main/java/org/bitcoinj/protocols/channels/PaymentChannelClientConnection.java
@@ -210,21 +210,7 @@ public ListenableFuture<PaymentChannelClientConnection> getChannelOpenFuture() {
     public ListenableFuture<PaymentIncrementAck> incrementPayment(Coin size) throws ValueOutOfRangeException, IllegalStateException {
         return channelClient.incrementPayment(size, null, null);
     }
-    /**
-     * Increments the total value which we pay the server.
-     *
-     * @param size How many satoshis to increment the payment by (note: not the new total).
-     * @param info Information about this payment increment, used to extend this protocol.
-     * @throws ValueOutOfRangeException If the size is negative or would pay more than this channel's total value
-     *                                  ({@link PaymentChannelClientConnection#state()}.getTotalValue())
-     * @throws IllegalStateException If the channel has been closed or is not yet open
-     *                               (see {@link PaymentChannelClientConnection#getChannelOpenFuture()} for the second)
-     */
-    /*
-    public ListenableFuture<PaymentIncrementAck> incrementPayment(Coin size, ByteString info) throws ValueOutOfRangeException, IllegalStateException {
-        return channelClient.incrementPayment(size, info, null);
-    }
-*/
+
     /**
      * Increments the total value which we pay the server.
      *

diff --git a/core/src/main/java/org/bitcoinj/utils/BtcFormat.java b/core/src/main/java/org/bitcoinj/utils/BtcFormat.java
@@ -1107,9 +1107,7 @@ public static BtcFormat getInstance(int scale, Locale locale, int minDecimals, L
         return new BtcFixedFormat(locale, scale, minDecimals, groups);
     }
 
-    /***********************/
-    /****** FORMATTING *****/
-    /***********************/
+    // ****** FORMATTING *****
 
     /**
      * Formats a bitcoin monetary value and returns an {@link java.text.AttributedCharacterIterator}.
@@ -1295,9 +1293,7 @@ else if (qty instanceof Coin)
         return satoshis;
     }
 
-    /********************/
-    /****** PARSING *****/
-    /********************/
+    // ****** PARSING *****
 
     /**
       * Parse a <code>String</code> representation of a Bitcoin monetary value.  Returns a
@@ -1461,9 +1457,7 @@ public Coin parse(String source) throws ParseException {
         return (Coin)parseObject(source);
     }
 
-    /*********************************/
     /****** END OF PARSING STUFF *****/
-    /*********************************/
 
     protected static String prefixCode(String code, int scale) {
         switch (scale) {

diff --git a/core/src/main/java/org/bitcoinj/wallet/Wallet.java b/core/src/main/java/org/bitcoinj/wallet/Wallet.java
@@ -437,7 +437,7 @@ public List<TransactionSigner> getTransactionSigners() {
         }
     }
 
-    /******************************************************************************************************************/
+    // ***************************************************************************************************************
 
     //region Key Management
 
@@ -1288,7 +1288,7 @@ public void changeEncryptionKey(KeyCrypter keyCrypter, KeyParameter currentAesKe
 
     //endregion
 
-    /******************************************************************************************************************/
+    // ***************************************************************************************************************
 
     //region Serialization support
 
@@ -1626,7 +1626,7 @@ public static Wallet loadFromFileStream(InputStream stream, @Nullable WalletExte
 
     //endregion
 
-    /******************************************************************************************************************/
+    // ***************************************************************************************************************
 
     //region Inbound transaction reception and processing
 
@@ -2531,7 +2531,7 @@ public void commitTx(Transaction tx) throws VerificationException {
 
     //endregion
 
-    /******************************************************************************************************************/
+    // ***************************************************************************************************************
 
     //region Event listeners
 
@@ -2791,7 +2791,7 @@ public void run() {
 
     //endregion
 
-    /******************************************************************************************************************/
+    // ***************************************************************************************************************
 
     //region Vending transactions and other internal state
 
@@ -3432,7 +3432,7 @@ public String getDescription() {
 
     //endregion
 
-    /******************************************************************************************************************/
+    // ***************************************************************************************************************
 
     //region Balance and balance futures
 
@@ -3662,7 +3662,7 @@ public Coin getTotalSent() {
 
     //endregion
 
-    /******************************************************************************************************************/
+    // ***************************************************************************************************************
 
     //region Creating and sending transactions
 
@@ -4286,8 +4286,7 @@ public void setUTXOProvider(@Nullable UTXOProvider provider) {
 
     //endregion
 
-    /******************************************************************************************************************/
-
+    // ***************************************************************************************************************
     /**
      * A custom {@link TransactionOutput} that is free standing. This contains all the information
      * required for spending without actually having all the linked data (i.e parent tx).
@@ -4337,10 +4336,7 @@ public Sha256Hash getParentTransactionHash() {
         }
     }
 
-    /******************************************************************************************************************/
-
-
-    /******************************************************************************************************************/
+    // ***************************************************************************************************************
 
     private static class TxOffsetPair implements Comparable<TxOffsetPair> {
         public final Transaction tx;
@@ -4691,7 +4687,7 @@ public boolean checkForFilterExhaustion(FilteredBlock block) {
 
     //endregion
 
-    /******************************************************************************************************************/
+    // ***************************************************************************************************************
 
     //region Extensions to the wallet format.
 
@@ -4938,7 +4934,7 @@ private int estimateBytesForSigning(CoinSelection selection) {
 
     //endregion
 
-    /******************************************************************************************************************/
+    // ***************************************************************************************************************
 
     //region Wallet maintenance transactions
 

diff --git a/core/src/test/java/org/bitcoinj/net/NetworkAbstractionTests.java b/core/src/test/java/org/bitcoinj/net/NetworkAbstractionTests.java
@@ -363,7 +363,7 @@ public void connectionClosed(ProtobufConnection<TwoWayChannelMessage> handler) {
 
     @Test
     public void largeDataTest() throws Exception {
-        /** Test various large-data handling, essentially testing {@link ProtobufConnection#receiveBytes(java.nio.ByteBuffer)} */
+        // Test various large-data handling, essentially testing {@link ProtobufConnection#receiveBytes(java.nio.ByteBuffer)}
         final SettableFuture<Void> serverConnectionOpen = SettableFuture.create();
         final SettableFuture<Void> clientConnectionOpen = SettableFuture.create();
         final SettableFuture<Void> serverConnectionClosed = SettableFuture.create();