Javadoc fixes

Author: GoodforGod

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>com.github.goodforgod</groupId>
   <artifactId>java-etherscan-api</artifactId>
-  <version>1.0.1</version>
+  <version>1.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>${project.groupId}:${project.artifactId}</name>
@@ -149,9 +149,6 @@
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-javadoc-plugin</artifactId>
             <version>${maven-javadoc-plugin-version}</version>
-            <configuration>
-              <additionalOptions>-html5</additionalOptions>
-            </configuration>
             <executions>
               <execution>
                 <id>attach-javadocs</id>
@@ -160,6 +157,9 @@
                 </goals>
               </execution>
             </executions>
+            <configuration>
+              <additionalOptions>-html5</additionalOptions>
+            </configuration>
           </plugin>
         </plugins>
       </build>

src/main/java/io/api/etherscan/core/IAccountApi.java

@@ -15,34 +15,61 @@
  */
 public interface IAccountApi {
 
-    /** Address ETH balance */
+    /**
+     * Address ETH balance
+     * @param address to look for
+     * @return balance
+     */
     @NotNull Balance balance(String address) throws ApiException;
 
-    /** ERC20 token balance for address */
+    /**
+     * ERC20 token balance for address
+     * @param address to look for
+     * @param contract for token
+     * @return  token balance
+     */
     @NotNull TokenBalance balance(String address, String contract) throws ApiException;
 
     /**
      * Maximum 20 address for single batch request
-     * If address > 20, then there will be more than 1 request performed
+     * If addresses more than 20, then there will be MORE than 1 request performed
+     * @param addresses to look for
+     * @return balance[0] for address[0], etc
      */
     @NotNull List<Balance> balances(List<String> addresses) throws ApiException;
 
-    /** All txs */
+    /**
+     * Find all txs
+     * @param address to look for txs
+     * @return tx info
+     */
     @NotNull List<Tx> txs(String address) throws ApiException;
     @NotNull List<Tx> txs(String address, long startBlock) throws ApiException;
     @NotNull List<Tx> txs(String address, long startBlock, long endBlock) throws ApiException;
 
-    /** All internal txs */
+    /**
+     * All internal txs
+     * @param address to look for
+     * @return internal tx
+     */
     @NotNull List<TxInternal> txsInternal(String address) throws ApiException;
     @NotNull List<TxInternal> txsInternal(String address, long startBlock) throws ApiException;
     @NotNull List<TxInternal> txsInternal(String address, long startBlock, long endBlock) throws ApiException;
     @NotNull List<TxInternal> txsInternalByHash(String txhash);
 
-    /** All token txs */
+    /**
+     * All token txs
+     * @param address to look for
+     * @return token txs
+     */
     @NotNull List<TxToken> txsToken(String address) throws ApiException;
     @NotNull List<TxToken> txsToken(String address, long startBlock) throws ApiException;
     @NotNull List<TxToken> txsToken(String address, long startBlock, long endBlock) throws ApiException;
 
-    /** All blocks mined by address */
+    /**
+     * All blocks mined by address
+     * @param address to look for
+     * @return mined blocks
+     */
     @NotNull List<Block> minedBlocks(String address) throws ApiException;
 }

src/main/java/io/api/etherscan/core/IBlockApi.java

@@ -15,6 +15,10 @@
  */
 public interface IBlockApi {
 
-    /** Return uncle blocks */
+    /**
+     * Return uncle blocks
+     * @param blockNumber block number
+     * @return uncle block
+     */
     @NotNull Optional<UncleBlock> uncles(long blockNumber) throws ApiException;
 }

src/main/java/io/api/etherscan/core/IContractApi.java

@@ -13,6 +13,10 @@
  */
 public interface IContractApi {
 
-    /** Get Verified Contract Sources */
+    /**
+     * Get Verified Contract Sources
+     * @param address to look for
+     * @return abi for contract
+     */
     @NotNull Abi contractAbi(String address) throws ApiException;
 }

src/main/java/io/api/etherscan/core/ILogsApi.java

@@ -17,8 +17,11 @@
 public interface ILogsApi {
 
     /**
-     * alternative to the native eth_getLogs
+     * Alternative to the native eth_getLogs
      * Read at EtherScan API description for full info!
+     * @see LogQuery
+     * @param query for logs (check etherscan specs)
+     * @return logs
      */
     @NotNull List<Log> logs(LogQuery query) throws ApiException;
 }

src/main/java/io/api/etherscan/core/IProxyApi.java

@@ -21,86 +21,115 @@ public interface IProxyApi {
     /**
      * Returns the number of most recent block
      * eth_blockNumber
+     * @return last block number
      */
     long blockNoLast();
 
     /**
      * Returns information about a block by block number
      * eth_getBlockByNumber
+     * @param blockNo block number
+     * @return block info
      */
     @NotNull Optional<BlockProxy> block(long blockNo) throws ApiException;
 
     /**
      * Returns information about a uncle by block number
      * eth_getUncleByBlockNumberAndIndex
+     * @param blockNo block number
+     * @param index uncle block index
+     * @return block info
      */
     @NotNull Optional<BlockProxy> blockUncle(long blockNo, long index) throws ApiException;
 
     /**
      * Returns the information about a transaction requested by transaction hash
      * eth_getTransactionByHash
+     * @param txhash tx hash
+     * @return tx info
      */
     @NotNull Optional<TxProxy> tx(String txhash) throws ApiException;
 
     /**
      * Returns information about a transaction by block number and transaction index position
      * eth_getTransactionByBlockNumberAndIndex
+     * @param blockNo block number
+     * @param index tx index in block
+     * @return tx info
      */
     @NotNull Optional<TxProxy> tx(long blockNo, long index) throws ApiException;
 
     /**
      * Returns the number of transactions in a block from a block matching the given block number
      * eth_getBlockTransactionCountByNumber
+     * @param blockNo block number
+     * @return tx count in block
      */
     int txCount(long blockNo) throws ApiException;
 
     /**
      * Returns the number of transactions sent from an address
      * eth_getTransactionCount
+     * @param address to look for
+     * @return tx send count
      */
     int txSendCount(String address) throws ApiException;
 
     /**
      * Creates new message call transaction or a contract creation for signed transactions
      * eth_sendRawTransaction
+     * @param hexEncodedTx tx as hex
+     * @return result (check eth grpc info)
      */
     @NotNull Optional<String> txSendRaw(String hexEncodedTx) throws ApiException;
 
     /**
      * Returns the receipt of a transaction by transaction hash
      * eth_getTransactionReceipt
+     * @param txhash tx hash
+     * @return receipt
      */
     @NotNull Optional<ReceiptProxy> txReceipt(String txhash) throws ApiException;
 
     /**
      * Executes a new message call immediately without creating a transaction on the block chain
      * eth_call
+     * @param address to look for
+     * @param data in tx for call
+     * @return result (check eth grpc info)
      */
     @NotNull Optional<String> call(String address, String data) throws ApiException;
 
     /**
      * Returns code at a given address
      * eth_getCode
+     * @param address to look for
+     * @return result (check eth grpc info)
      */
     @NotNull Optional<String> code(String address) throws ApiException;
 
     /**
      * (**experimental)
      * Returns the value from a storage position at a given address
      * eth_getStorageAt
+     * @param address to look for
+     * @param position storage position
+     * @return result (check eth grpc info)
      */
     @NotNull Optional<String> storageAt(String address, long position) throws ApiException;
 
     /**
      * Returns the current price per gas in wei
      * eth_gasPrice
+     * @return price
      */
     @NotNull BigInteger gasPrice() throws ApiException;
 
     /**
      * Makes a call or transaction, which won't be added to the blockchain and returns the used gas,
      * which can be used for estimating the used gas
      * eth_estimateGas
+     * @return gas estimate
      */
     @NotNull BigInteger gasEstimated() throws ApiException;
     @NotNull BigInteger gasEstimated(String hexData) throws ApiException;

src/main/java/io/api/etherscan/core/IStatisticApi.java

@@ -16,12 +16,22 @@
  */
 public interface IStatisticApi {
 
-    /** ERC20 token total Supply */
+    /**
+     * ERC20 token total Supply
+     * @param contract to look for
+     * @return token supply
+     */
     @NotNull BigInteger supply(String contract) throws ApiException;
 
-    /** Eth total supply */
+    /**
+     * Eth total supply
+     * @return ETH supply
+     */
     @NotNull Supply supply() throws ApiException;
 
-    /** Eth last USD and BTC price */
+    /**
+     * Eth last USD and BTC price
+     * @return last price
+     */
     @NotNull Price lastPrice() throws ApiException;
 }

src/main/java/io/api/etherscan/core/ITransactionApi.java

@@ -15,12 +15,19 @@
  */
 public interface ITransactionApi {
 
-    /** Check Contract Execution Status (if there was an error during contract execution) */
+    /**
+     * Check Contract Execution Status (if there was an error during contract execution)
+     * @param txhash to look for
+     * @return exec status
+     */
     @NotNull Optional<Status> execStatus(String txhash) throws ApiException;
 
-    /** Check Transaction Receipt Status (Only applicable for Post Byzantium fork transactions)
+    /**
+     * Check Transaction Receipt Status (Only applicable for Post Byzantium fork transactions)
      * 0 = Fail, 1 = Pass
      * empty value for pre-byzantium fork
-     * */
+     * @param txhash to look for
+     * @return status as boolean
+     */
     @NotNull Optional<Boolean> receiptStatus(String txhash) throws ApiException;
 }

src/main/java/io/api/etherscan/core/impl/EtherScanApi.java

@@ -83,57 +83,36 @@ public EtherScanApi(final String apiKey,
         this.txs = new TransactionApiProvider(masterQueue, baseUrl, executor);
     }
 
-    /**
-     * API for interactions with account and address
-     */
     @NotNull
     public IAccountApi account() {
         return account;
     }
 
-    /**
-     * API for verifying contract ABI
-     */
     @NotNull
     public IContractApi contract() {
         return contract;
     }
 
-    /**
-     * [BETA] API for interaction with tx statuses
-     */
     @NotNull
     public ITransactionApi txs() {
         return txs;
     }
 
-    /**
-     * [BETA] API for getting block rewards and uncles
-     */
     @NotNull
     public IBlockApi block() {
         return block;
     }
 
-    /**
-     * [BETA] API for interaction with eth_getLogs
-     */
     @NotNull
     public ILogsApi logs() {
         return logs;
     }
 
-    /**
-     * API for interacting with geth/proxy etherscan
-     */
     @NotNull
     public IProxyApi proxy() {
         return proxy;
     }
 
-    /**
-     * API for eth price and supply statistic
-     */
     @NotNull
     public IStatisticApi stats() {
         return stats;

src/main/java/io/api/etherscan/manager/IQueueManager.java

@@ -12,6 +12,7 @@ public interface IQueueManager {
 
     /**
      * Waits in queue for chance to take turn
+     * @return is turn available
      */
     boolean takeTurn();
 }

src/test/java/io/api/manager/QueueManagerTest.java

@@ -43,9 +43,9 @@ public void queueManagerWithDelay() {
     public void queueManagerTimeout() {
         IQueueManager queueManager = new QueueManager(1, 3);
         assertTrue(queueManager.takeTurn());
-        long start = System.currentTimeMillis();
+        final long start = System.currentTimeMillis();
         queueManager.takeTurn();
-        long end = System.currentTimeMillis();
-        assertEquals(3, (end - start) / 1000);
+        final long end = System.currentTimeMillis();
+        assertEquals(3, (end - start) / 950);
     }
 }