JavaDoc: Fix dangling comments.

This commit is contained in:
Andreas Schildbach
2018-03-11 16:14:19 +01:00
parent dffc060edf
commit 43a254d6f3
5 changed files with 16 additions and 40 deletions

View File

@@ -340,10 +340,10 @@ public class FullPrunedBlockChain extends AbstractBlockChain {
return new TransactionOutputChanges(txOutsCreated, txOutsSpent); return new TransactionOutputChanges(txOutsCreated, txOutsSpent);
} }
@Override
/** /**
* Used during reorgs to connect a block previously on a fork * Used during reorgs to connect a block previously on a fork
*/ */
@Override
protected synchronized TransactionOutputChanges connectTransactions(StoredBlock newBlock) protected synchronized TransactionOutputChanges connectTransactions(StoredBlock newBlock)
throws VerificationException, BlockStoreException, PrunedException { throws VerificationException, BlockStoreException, PrunedException {
checkState(lock.isHeldByCurrentThread()); checkState(lock.isHeldByCurrentThread());

View File

@@ -246,21 +246,7 @@ public class PaymentChannelClientConnection {
public ListenableFuture<PaymentIncrementAck> incrementPayment(Coin size) throws ValueOutOfRangeException, IllegalStateException { public ListenableFuture<PaymentIncrementAck> incrementPayment(Coin size) throws ValueOutOfRangeException, IllegalStateException {
return channelClient.incrementPayment(size, null, null); 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. * Increments the total value which we pay the server.
* *

View File

@@ -1107,9 +1107,7 @@ public abstract class BtcFormat extends Format {
return new BtcFixedFormat(locale, scale, minDecimals, groups); return new BtcFixedFormat(locale, scale, minDecimals, groups);
} }
/***********************/ // ****** FORMATTING *****
/****** FORMATTING *****/
/***********************/
/** /**
* Formats a bitcoin monetary value and returns an {@link java.text.AttributedCharacterIterator}. * Formats a bitcoin monetary value and returns an {@link java.text.AttributedCharacterIterator}.
@@ -1295,9 +1293,7 @@ public abstract class BtcFormat extends Format {
return satoshis; return satoshis;
} }
/********************/ // ****** PARSING *****
/****** PARSING *****/
/********************/
/** /**
* Parse a <code>String</code> representation of a Bitcoin monetary value. Returns a * Parse a <code>String</code> representation of a Bitcoin monetary value. Returns a
@@ -1462,9 +1458,7 @@ public abstract class BtcFormat extends Format {
return (Coin)parseObject(source); return (Coin)parseObject(source);
} }
/*********************************/
/****** END OF PARSING STUFF *****/ /****** END OF PARSING STUFF *****/
/*********************************/
protected static String prefixCode(String code, int scale) { protected static String prefixCode(String code, int scale) {
switch (scale) { switch (scale) {

View File

@@ -397,7 +397,7 @@ public class Wallet extends BaseTaggableObject
} }
} }
/******************************************************************************************************************/ // ***************************************************************************************************************
//region Key Management //region Key Management
@@ -1270,7 +1270,7 @@ public class Wallet extends BaseTaggableObject
//endregion //endregion
/******************************************************************************************************************/ // ***************************************************************************************************************
//region Serialization support //region Serialization support
@@ -1608,7 +1608,7 @@ public class Wallet extends BaseTaggableObject
//endregion //endregion
/******************************************************************************************************************/ // ***************************************************************************************************************
//region Inbound transaction reception and processing //region Inbound transaction reception and processing
@@ -2496,7 +2496,7 @@ public class Wallet extends BaseTaggableObject
//endregion //endregion
/******************************************************************************************************************/ // ***************************************************************************************************************
//region Event listeners //region Event listeners
@@ -2797,7 +2797,7 @@ public class Wallet extends BaseTaggableObject
//endregion //endregion
/******************************************************************************************************************/ // ***************************************************************************************************************
//region Vending transactions and other internal state //region Vending transactions and other internal state
@@ -3429,7 +3429,7 @@ public class Wallet extends BaseTaggableObject
//endregion //endregion
/******************************************************************************************************************/ // ***************************************************************************************************************
//region Balance and balance futures //region Balance and balance futures
@@ -3671,7 +3671,7 @@ public class Wallet extends BaseTaggableObject
//endregion //endregion
/******************************************************************************************************************/ // ***************************************************************************************************************
//region Creating and sending transactions //region Creating and sending transactions
@@ -4298,8 +4298,7 @@ public class Wallet extends BaseTaggableObject
//endregion //endregion
/******************************************************************************************************************/ // ***************************************************************************************************************
/** /**
* A custom {@link TransactionOutput} that is free standing. This contains all the information * 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). * required for spending without actually having all the linked data (i.e parent tx).
@@ -4349,10 +4348,7 @@ public class Wallet extends BaseTaggableObject
} }
} }
/******************************************************************************************************************/ // ***************************************************************************************************************
/******************************************************************************************************************/
private static class TxOffsetPair implements Comparable<TxOffsetPair> { private static class TxOffsetPair implements Comparable<TxOffsetPair> {
public final Transaction tx; public final Transaction tx;
@@ -4703,7 +4699,7 @@ public class Wallet extends BaseTaggableObject
//endregion //endregion
/******************************************************************************************************************/ // ***************************************************************************************************************
//region Extensions to the wallet format. //region Extensions to the wallet format.
@@ -5016,7 +5012,7 @@ public class Wallet extends BaseTaggableObject
//endregion //endregion
/******************************************************************************************************************/ // ***************************************************************************************************************
//region Wallet maintenance transactions //region Wallet maintenance transactions

View File

@@ -363,7 +363,7 @@ public class NetworkAbstractionTests {
@Test @Test
public void largeDataTest() throws Exception { 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> serverConnectionOpen = SettableFuture.create();
final SettableFuture<Void> clientConnectionOpen = SettableFuture.create(); final SettableFuture<Void> clientConnectionOpen = SettableFuture.create();
final SettableFuture<Void> serverConnectionClosed = SettableFuture.create(); final SettableFuture<Void> serverConnectionClosed = SettableFuture.create();