chore: fix java docs

zksync-sdk · Jun 7, 2024 · 6ae9a8a · 6ae9a8a
1 parent f5eb099
commit 6ae9a8a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 10 deletions.
diff --git a/src/main/java/io/zksync/protocol/ZkSync.java b/src/main/java/io/zksync/protocol/ZkSync.java
@@ -191,9 +191,9 @@ Request<?, ZksBlock> zksGetBlockByNumber(
      * Returns the L2 token address equivalent for a L1 token address as they are not necessarily equal.
      * The ETH address is set to the zero address.
      *
-     * @remarks Only works for tokens bridged on default zkSync Era bridges.
+     * Only works for tokens bridged on default zkSync Era bridges.
      *
-     * @param token The address of the token on L1.
+     * @param tokenAddress The address of the token on L1.
      */
     String l2TokenAddress(String tokenAddress);
 

diff --git a/src/main/java/io/zksync/protocol/account/WalletL1.java b/src/main/java/io/zksync/protocol/account/WalletL1.java
@@ -183,8 +183,8 @@ public CompletableFuture<BigInteger> getBalanceL1Async(String address, String to
      * @param token         The L1 address of the token.
      * @param amount        The amount of the token to be approved.
      * @param bridgeAddress Bridge address to be used.
-     * @throws {Error} If attempting to approve an ETH token.
-     * @returns A promise that resolves to the response of the approval transaction.
+     * @throws Error If attempting to approve an ETH token.
+     * @return A promise that resolves to the response of the approval transaction.
      */
     public RemoteFunctionCall<TransactionReceipt> approveERC20(String token, @Nullable BigInteger amount, @Nullable String bridgeAddress) {
         if (ZkSyncAddresses.isEth(token)){
@@ -223,7 +223,7 @@ public RemoteFunctionCall<BigInteger> getAllowanceL1(String token, @Nullable Str
      * Returns the L2 token address equivalent for a L1 token address as they are not necessarily equal.
      * The ETH address is set to the zero address.
      *
-     * @remarks Only works for tokens bridged on default zkSync Era bridges.
+     * Only works for tokens bridged on default zkSync Era bridges.
      *
      * @param l1Address The address of the token on L1.
      */
@@ -238,7 +238,7 @@ private EthSigner getSigner() {
     /**
      * Returns L1 bridge contracts.
      *
-     * @remarks There is no separate Ether bridge contract, {@link } is used instead.
+     * There is no separate Ether bridge contract, {@link } is used instead.
      */
     public L1BridgeContracts getL1BridgeContracts(){
         BridgeAddresses bridgeAddresses = providerL2.zksGetBridgeContracts().sendAsync().join().getResult();

diff --git a/src/main/java/io/zksync/utils/ZkSyncAddresses.java b/src/main/java/io/zksync/utils/ZkSyncAddresses.java
@@ -4,19 +4,16 @@ public final class ZkSyncAddresses {
 
     /**
      * The address of the L1 `ETH` token.
-     * @constant
      */
     @Deprecated
     public static final String ETH_ADDRESS = "0x0000000000000000000000000000000000000000";
     /**
      * The address of the L1 `ETH` token.
-     * @constant
      */
     public static final String LEGACY_ETH_ADDRESS = "0x0000000000000000000000000000000000000000";
 
     /**
      * In the contracts the zero address can not be used, use one instead
-     * @constant
      */
     public static final String ETH_ADDRESS_IN_CONTRACTS = "0x0000000000000000000000000000000000000001";
     public static final String CONTRACT_DEPLOYER_ADDRESS = "0x0000000000000000000000000000000000008006";
@@ -26,7 +23,6 @@ public final class ZkSyncAddresses {
     public static final String L2_ETH_TOKEN_ADDRESS = "0x000000000000000000000000000000000000800a";
     /**
      * The address of the base token.
-     * @constant
      */
     public static final String L2_BASE_TOKEN_ADDRESS = "0x000000000000000000000000000000000000800a";
     public static final String BOOTLOADER_FORMAL_ADDRESS = "0x0000000000000000000000000000000000008001";