mirrors/bitcoinj
1
0
Fork 0
mirror of https://github.com/bitcoinj/bitcoinj.git synced 2025-01-19 05:33:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

In JavaDocs change <tt> tags to @code.

Browse Source
This commit is contained in:
Nicola Atzei 2019-01-03 23:00:53 +01:00 committed by Andreas Schildbach
parent 0875d4a5b3
commit 0833fe1cea
10 changed files with 17 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/src/main/java/org/bitcoinj/core/AbstractBlockChain.java
View File

@ -857,7 +857,7 @@ public abstract class AbstractBlockChain {
}
/**
* @return the height of the best known chain, convenience for <tt>getChainHead().getHeight()</tt>.
* @return the height of the best known chain, convenience for {@code getChainHead().getHeight()}.
*/
public final int getBestChainHeight() {
return getChainHead().getHeight();

10
core/src/main/java/org/bitcoinj/core/ECKey.java
View File

@ -444,8 +444,8 @@ public class ECKey implements EncryptableItem {
}
/**
* Returns public key bytes from the given private key. To convert a byte array into a BigInteger, use <tt>
* new BigInteger(1, bytes);</tt>
* Returns public key bytes from the given private key. To convert a byte array into a BigInteger,
* use {@code new BigInteger(1, bytes);}
*/
public static byte[] publicKeyFromPrivate(BigInteger privKey, boolean compressed) {
ECPoint point = publicPointFromPrivate(privKey);
@ -453,8 +453,8 @@ public class ECKey implements EncryptableItem {
}
/**
* Returns public key point from the given private key. To convert a byte array into a BigInteger, use <tt>
* new BigInteger(1, bytes);</tt>
* Returns public key point from the given private key. To convert a byte array into a BigInteger,
* use {@code new BigInteger(1, bytes);}
*/
public static ECPoint publicPointFromPrivate(BigInteger privKey) {
/*
@ -1310,7 +1310,7 @@ public class ECKey implements EncryptableItem {
/**
* <p>Given a textual message, returns a byte buffer formatted as follows:</p>
* <p><tt>[24] "Bitcoin Signed Message:\n" [message.length as a varint] message</tt></p>
* <p>{@code [24] "Bitcoin Signed Message:\n" [message.length as a varint] message}</p>
*/
private static byte[] formatMessageForSigning(String message) {
try {

2
core/src/main/java/org/bitcoinj/core/StoredBlock.java
View File

@ -107,7 +107,7 @@ public class StoredBlock {
/**
* Given a block store, looks up the previous block in this chain. Convenience method for doing
* <tt>store.get(this.getHeader().getPrevBlockHash())</tt>.
* {@code store.get(this.getHeader().getPrevBlockHash())}.
*
* @return the previous block in the chain or null if it was not found in the store.
*/

2
core/src/main/java/org/bitcoinj/core/TransactionInput.java
View File

@ -497,7 +497,7 @@ public class TransactionInput extends ChildMessage {
* The "IsStandard" rules control whether the default Bitcoin Core client blocks relay of a tx / refuses to mine it,
* however, non-standard transactions can still be included in blocks and will be accepted as valid if so.</p>
*
* <p>This method simply calls <tt>DefaultRiskAnalysis.isInputStandard(this)</tt>.</p>
* <p>This method simply calls {@code DefaultRiskAnalysis.isInputStandard(this)}.</p>
*/
public DefaultRiskAnalysis.RuleViolation isStandard() {
return DefaultRiskAnalysis.isInputStandard(this);

2
core/src/main/java/org/bitcoinj/core/VersionMessage.java
View File

@ -245,7 +245,7 @@ public class VersionMessage extends Message {
* and version are not allowed to contain such characters.</p>
*
* <p>Anything put in the "comments" field will appear in brackets and may be used for platform info, or anything
* else. For example, calling <tt>appendToSubVer("MultiBit", "1.0", "Windows")</tt> will result in a subVer being
* else. For example, calling {@code appendToSubVer("MultiBit", "1.0", "Windows")} will result in a subVer being
* set of "/bitcoinj:1.0/MultiBit:1.0(Windows)/". Therefore the / ( and ) characters are reserved in all these
* components. If you don't want to add a comment (recommended), pass null.</p>
*

5
core/src/main/java/org/bitcoinj/core/listeners/TransactionConfidenceEventListener.java
View File

@ -38,9 +38,8 @@ public interface TransactionConfidenceEventListener {
* will then re-use the same outputs when creating the next spend.</li>
* </ol><p>
*
* <p>To find if the transaction is dead, you can use <tt>tx.getConfidence().getConfidenceType() ==
* TransactionConfidence.ConfidenceType.DEAD</tt>. If it is, you should notify the user
* in some way so they know the thing they bought may not arrive/the thing they sold should not be dispatched.</p>
* <p>To find if the transaction is dead, you can use {@code tx.getConfidence().getConfidenceType() == TransactionConfidence.ConfidenceType.DEAD}.
* If it is, you should notify the user in some way so they know the thing they bought may not arrive/the thing they sold should not be dispatched.</p>
*
* <p>Note that this callback will be invoked for every transaction in the wallet, for every new block that is
* received (because the depth has changed). <b>If you want to update a UI view from the contents of the wallet

4
core/src/main/java/org/bitcoinj/utils/MonetaryFormat.java
View File

@ -150,7 +150,7 @@ public final class MonetaryFormat {
* </p>
*
* <p>
* For example, if you pass <tt>4,2</tt> it will add four decimals to your formatted string if needed, and then add
* For example, if you pass {@code 4,2} it will add four decimals to your formatted string if needed, and then add
* another two decimals if needed. At this point, rather than adding further decimals the value will be rounded.
* </p>
*
@ -173,7 +173,7 @@ public final class MonetaryFormat {
* </p>
*
* <p>
* For example, if you pass <tt>1,8</tt> it will up to eight decimals to your formatted string if needed. After
* For example, if you pass {@code 1,8} it will up to eight decimals to your formatted string if needed. After
* these have been used up, rather than adding further decimals the value will be rounded.
* </p>
*

2
core/src/main/java/org/bitcoinj/wallet/Wallet.java
View File

@ -4242,7 +4242,7 @@ public class Wallet extends BaseTaggableObject
}
/**
* Convenience wrapper for <tt>setCoinSelector(Wallet.AllowUnconfirmedCoinSelector.get())</tt>. If this method
* Convenience wrapper for {@code setCoinSelector(Wallet.AllowUnconfirmedCoinSelector.get())}. If this method
* is called on the wallet then transactions will be used for spending regardless of their confidence. This can
* be dangerous - only use this if you absolutely know what you're doing!
*/

4
core/src/main/java/org/bitcoinj/wallet/WalletProtobufSerializer.java
View File

@ -67,7 +67,7 @@ import static com.google.common.base.Preconditions.checkNotNull;
* a data interchange format developed by Google with an efficient binary representation, a type safe specification
* language and compilers that generate code to work with those data structures for many languages. Protocol buffers
* can have their format evolved over time: conceptually they represent data using (tag, length, value) tuples. The
* format is defined by the <tt>wallet.proto</tt> file in the bitcoinj source distribution.<p>
* format is defined by the {@code wallet.proto} file in the bitcoinj source distribution.<p>
*
* This class is used through its static methods. The most common operations are writeWallet and readWallet, which do
* the obvious operations on Output/InputStreams. You can use a {@link ByteArrayInputStream} and equivalent
@ -147,7 +147,7 @@ public class WalletProtobufSerializer {
/**
* Formats the given wallet (transactions and keys) to the given output stream in protocol buffer format.<p>
*
* Equivalent to <tt>walletToProto(wallet).writeTo(output);</tt>
* Equivalent to {@code walletToProto(wallet).writeTo(output);}
*/
public void writeWallet(Wallet wallet, OutputStream output) throws IOException {
Protos.Wallet walletProto = walletToProto(wallet);

2
wallettemplate/src/main/java/wallettemplate/utils/easing/ElasticInterpolator.java
View File

@ -96,7 +96,7 @@ public class ElasticInterpolator extends EasingInterpolator {
}
/**
* The amplitude. The minimum value is 1. If this value is < 1 it will be set to 1 during animation.
* The amplitude. The minimum value is 1. If this value is &lt; 1 it will be set to 1 during animation.
*
* @return The property.
* @see #getAmplitude()