mirrors/bitcoinj
1
0
Fork 0
mirror of https://github.com/bitcoinj/bitcoinj.git synced 2025-03-13 11:36:15 +01:00
Code Issues Projects Releases Packages Wiki Activity

SegwitAddress, LegacyAddress, package-info.java: don't link to classes outside base in JavaDoc

Browse source 
Use `@code` rather than `@link` in these cases.
This commit is contained in:
Andreas Schildbach 2024-08-29 21:18:16 +02:00
parent 3a45d13895
commit eef3f8f8d9
4 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
core/src/main/java/org/bitcoinj/base/Address.java
View file

@ -28,7 +28,7 @@ import java.util.Comparator;
*/
public interface Address extends Comparable<Address> {
/**
* Construct an {@link Address} that represents the public part of the given {@link ECKey}.
* Construct an {@link Address} that represents the public part of the given {@code ECKey}.
*
* @param params
* network this address is valid for

8
core/src/main/java/org/bitcoinj/base/LegacyAddress.java
View file

@ -55,7 +55,7 @@ public class LegacyAddress implements Address {
/**
* Private constructor. Use {@link #fromBase58(String, Network)},
* {@link #fromPubKeyHash(Network, byte[])}, {@link #fromScriptHash(Network, byte[])} or
* {@link ECKey#toAddress(ScriptType, Network)}.
* {@code ECKey#toAddress(ScriptType, Network)}.
*
* @param network
* network this address is valid for
@ -113,7 +113,7 @@ public class LegacyAddress implements Address {
}
/**
* Construct a {@link LegacyAddress} that represents the public part of the given {@link ECKey}. Note that an address is
* Construct a {@link LegacyAddress} that represents the public part of the given {@code ECKey}. Note that an address is
* derived from a hash of the public key and is not the public key itself.
*
* @param params
@ -121,7 +121,7 @@ public class LegacyAddress implements Address {
* @param key
* only the public part is used
* @return constructed address
* @deprecated Use {@link ECKey#toAddress(ScriptType, Network)}
* @deprecated Use {@code ECKey#toAddress(ScriptType, Network)}
*/
@Deprecated
public static LegacyAddress fromKey(NetworkParameters params, ECKey key) {
@ -175,7 +175,7 @@ public class LegacyAddress implements Address {
}
/**
* Get the network this address works on. Use of {@link BitcoinNetwork} is preferred to use of {@link NetworkParameters}
* Get the network this address works on. Use of {@link BitcoinNetwork} is preferred to use of {@code NetworkParameters}
* when you need to know what network an address is for.
* @return the Network.
*/

10
core/src/main/java/org/bitcoinj/base/SegwitAddress.java
View file

@ -43,7 +43,7 @@ import java.util.stream.Stream;
* <a href="https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki">BIP173</a> for details.</p>
*
* <p>However, you don't need to care about the internals. Use {@link #fromBech32(String, Network)},
* {@link #fromHash(org.bitcoinj.base.Network, byte[])} or {@link ECKey#toAddress(ScriptType, Network)}
* {@link #fromHash(org.bitcoinj.base.Network, byte[])} or {@code ECKey#toAddress(ScriptType, Network)}
* to construct a native segwit address.</p>
*/
public class SegwitAddress implements Address {
@ -133,7 +133,7 @@ public class SegwitAddress implements Address {
/**
* Private constructor. Use {@link #fromBech32(String, Network)},
* {@link #fromHash(Network, byte[])} or {@link ECKey#toAddress(ScriptType, Network)}.
* {@link #fromHash(Network, byte[])} or {@code ECKey#toAddress(ScriptType, Network)}.
*
* @param network
* network this address is valid for
@ -320,7 +320,7 @@ public class SegwitAddress implements Address {
}
/**
* Construct a {@link SegwitAddress} that represents the public part of the given {@link ECKey}. Note that an
* Construct a {@link SegwitAddress} that represents the public part of the given {@code ECKey}. Note that an
* address is derived from a hash of the public key and is not the public key itself.
*
* @param params
@ -328,7 +328,7 @@ public class SegwitAddress implements Address {
* @param key
* only the public part is used
* @return constructed address
* @deprecated Use {@link ECKey#toAddress(ScriptType, org.bitcoinj.base.Network)}
* @deprecated Use {@code ECKey#toAddress(ScriptType, org.bitcoinj.base.Network)}
*/
@Deprecated
public static SegwitAddress fromKey(NetworkParameters params, ECKey key) {
@ -336,7 +336,7 @@ public class SegwitAddress implements Address {
}
/**
* Get the network this address works on. Use of {@link BitcoinNetwork} is preferred to use of {@link NetworkParameters}
* Get the network this address works on. Use of {@link BitcoinNetwork} is preferred to use of {@code NetworkParameters}
* when you need to know what network an address is for.
* @return the Network.
*/

2
core/src/main/java/org/bitcoinj/base/package-info.java
View file

@ -23,7 +23,7 @@
* </ul>
* <p>
* <b>Temporary exception:</b> In the 0.17 release, we are allowing some dependencies on other packages, e.g. to
* {@link org.bitcoinj.core.NetworkParameters} or to Guava <i>provided</i> that those references are in <b>deprecated</b> methods.
* {@code org.bitcoinj.core.NetworkParameters} or to Guava <i>provided</i> that those references are in <b>deprecated</b> methods.
* This smooths migration by allowing users to, for example, replace {@code import org.bitcoinj.core.Address} with
* {@code import org.bitcoinj.base.Address} as first step of conversion and then remove usages of the deprecated methods
* of {@code Address} in a second step.