Fix remaining javadoc warnings

As of this commit there are now warnings at the command line when
running `gradle javadoc`.
This commit is contained in:
Chris Beams 2014-12-27 14:39:35 +01:00
parent 687c27e54b
commit abb1ad8956
No known key found for this signature in database
GPG Key ID: 3D214F8F5BC5ED73
8 changed files with 27 additions and 59 deletions

View File

@ -225,13 +225,8 @@ public class TransactionExecutor {
}
/**
* After any contract code finish the run the certain result should take
* place, according the given circumstances
*
* @param result
* @param gasDebit
* @param senderAddress
* @param contractAddress
* After any contract code finish the run the certain result should take place,
* according to the given circumstances.
*/
private void applyProgramResult(ProgramResult result, BigInteger gasDebit,
BigInteger gasPrice, Repository repository, byte[] senderAddress,

View File

@ -120,10 +120,7 @@ public class Wallet {
/**
* The wallet will call this method once transaction been send to the network,
* once the the GET_TRANSACTION will be answered with that particular transaction
* it will be considered as received by the net
*
* @param transaction
* @return
* it will be considered as received by the net.
*/
public WalletTransaction addByWalletTransaction(Transaction transaction) {
String hash = Hex.toHexString(transaction.getHash());
@ -133,12 +130,14 @@ public class Wallet {
return walletTransaction;
}
/***********************************************************************
* 1) the dialog put a pending transaction on the list
* 2) the dialog send the transaction to a net
* 3) wherever the transaction got in from the wire it will change to approve state
* 4) only after the approve a) Wallet state changes
* 5) After the block is received with that tx the pending been clean up
/**
* <ol>
* <li> the dialog put a pending transaction on the list
* <li> the dialog send the transaction to a net
* <li> wherever the transaction got in from the wire it will change to approve state
* <li> only after the approve a) Wallet state changes
* <li> after the block is received with that tx the pending been clean up
* </ol>
*/
public WalletTransaction addTransaction(Transaction transaction) {
String hash = Hex.toHexString(transaction.getHash());

View File

@ -106,13 +106,10 @@ public interface Ethereum {
BigInteger value, byte[] data);
/**
*
* @param transaction - submit transaction to the net, return
* option to wait for net return this transaction
* as approved
* @return
*/
/**
* @param transaction submit transaction to the net, return option to wait for net
* return this transaction as approved
*/
public Future<Transaction> submitTransaction(Transaction transaction);

View File

@ -197,9 +197,7 @@ public class SerpentCompiler {
}
/**
* @param code
* @param init
* @return encoded bytes
* Return encoded bytes.
*/
public static byte[] encodeMachineCodeForVMRun(byte[] code, byte[] init) {

View File

@ -713,7 +713,6 @@ public class SerpentToAssemblyCompiler extends SerpentBaseVisitor<String> {
/**
* @param hexNum should be in form '0x34fabd34....'
* @return
*/
private String hexStringToDecimalString(String hexNum) {
String digits = hexNum.substring(2);

View File

@ -94,10 +94,7 @@ public class TrieImpl implements Trie {
**************************************/
/**
* Retrieve a value from a key as String
*
* @param key
* @return value
* Retrieve a value from a key as String.
*/
public byte[] get(String key) {
return this.get(key.getBytes());
@ -114,10 +111,7 @@ public class TrieImpl implements Trie {
}
/**
* Insert key/value pair into trie
*
* @param key
* @param value
* Insert key/value pair into trie.
*/
public void update(String key, String value) {
this.update(key.getBytes(), value.getBytes());
@ -137,9 +131,7 @@ public class TrieImpl implements Trie {
}
/**
* Delete a key/value pair from the trie
*
* @param key
* Delete a key/value pair from the trie.
*/
public void delete(String key) {
this.update(key.getBytes(), "".getBytes());
@ -207,8 +199,8 @@ public class TrieImpl implements Trie {
}
/**
* Update or add the item inside a node
* return the updated node with rlp encoded
* Update or add the item inside a node.
* @return the updated node with rlp encoded
*/
private Object insert(Object node, byte[] key, Object value) {
@ -345,12 +337,8 @@ public class TrieImpl implements Trie {
}
/**
* Helper method to retrieve the actual node
* If the node is not a list and length is > 32
* bytes get the actual node from the db
*
* @param node -
* @return
* Helper method to retrieve the actual node. If the node is not a list and length
* is > 32 bytes get the actual node from the db.
*/
private Value getNode(Object node) {

View File

@ -90,27 +90,21 @@ public class Program {
}
/**
* Last Op can only be set publicly (no getLastOp method), is used for logging
*
* @param op
* Last Op can only be set publicly (no getLastOp method), is used for logging.
*/
public void setLastOp(byte op) {
this.lastOp = op;
}
/**
* Should be set only after the OP is fully executed
*
* @param op
* Should be set only after the OP is fully executed.
*/
public void setPreviouslyExecutedOp(byte op) {
this.previouslyExecutedOp = op;
}
/**
* returns the last fully executed OP
*
* @return
* Returns the last fully executed OP.
*/
public byte getPreviouslyExecutedOp() {
return this.previouslyExecutedOp;

View File

@ -23,9 +23,7 @@ public class ProgramTrace {
}
/**
* used for merging sub calls execution
*
* @param programTrace
* Used for merging sub calls execution.
*/
public void merge(ProgramTrace programTrace) {