Polish Javadoc
Fix syntax for @author and @since tags, for the same reasons detailed in commits7d2cf7f
andc38907b
, respectively. Recommendations: - Disable automatic Javadoc templates completely within IDEA. - Add Javadoc by hand when new classes are created. - Follow the proper conventions for `@author` and `@since` tags. - Do not add @since tags in src/test classes. Javadoc for these types will never be generated or published, and developers can query creation date metadata (more accurately) from git for these classes. Note that in the future--particularly once ethereumj has its own independent versioning--it will be desirable to use `@since` tags with version values (for semantic versioning clarity, backward compatibility analysis and communication, etc). Until then, the `@since DD.MM.YY` approach will suffice.
This commit is contained in:
parent
a3a180dc59
commit
d55bc10a1a
|
@ -4,11 +4,9 @@ import java.util.Map;
|
|||
import java.util.Set;
|
||||
|
||||
/**
|
||||
*
|
||||
* @author: Roman Mandeleil
|
||||
* Created on: 18/01/2015 21:40
|
||||
* @author Roman Mandeleil
|
||||
* @since 18.01.2015
|
||||
*/
|
||||
|
||||
public interface KeyValueDataSource {
|
||||
|
||||
public void init();
|
||||
|
|
|
@ -20,11 +20,9 @@ import java.util.Set;
|
|||
import static org.iq80.leveldb.impl.Iq80DBFactory.factory;
|
||||
|
||||
/**
|
||||
*
|
||||
* @author: Roman Mandeleil
|
||||
* Created on: 18/01/2015 21:48
|
||||
* @author Roman Mandeleil
|
||||
* @since 18.01.2015
|
||||
*/
|
||||
|
||||
public class LevelDbDataSource implements KeyValueDataSource{
|
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger("db");
|
||||
|
|
|
@ -11,11 +11,9 @@ import java.util.concurrent.atomic.AtomicInteger;
|
|||
import static org.ethereum.config.SystemProperties.CONFIG;
|
||||
|
||||
/**
|
||||
*
|
||||
* @author: Roman Mandeleil
|
||||
* Created on: 18/01/2015 21:48
|
||||
* @author Roman Mandeleil
|
||||
* @since 18.01.2015
|
||||
*/
|
||||
|
||||
public class RedisDataSource implements KeyValueDataSource{
|
||||
|
||||
String name;
|
||||
|
|
|
@ -8,10 +8,9 @@ import java.math.BigInteger;
|
|||
import java.util.List;
|
||||
|
||||
/**
|
||||
* @author: Roman Mandeleil
|
||||
* Created on: 08/01/2015 10:27
|
||||
* @author Roman Mandeleil
|
||||
* @since 08.01.2015
|
||||
*/
|
||||
|
||||
public interface BlockStore {
|
||||
|
||||
public byte[] getBlockHashByNumber(long blockNumber);
|
||||
|
|
|
@ -9,15 +9,14 @@ import java.math.BigInteger;
|
|||
import java.util.List;
|
||||
|
||||
/**
|
||||
* @author: Roman Mandeleil
|
||||
* Created on: 08/01/2015 17:33
|
||||
* @author Roman Mandeleil
|
||||
* @since 08.01.2015
|
||||
*/
|
||||
|
||||
public class BlockStoreDummy implements BlockStore{
|
||||
|
||||
|
||||
@Override
|
||||
public byte[] getBlockHashByNumber(long blockNumber) {
|
||||
|
||||
|
||||
byte[] data = String.valueOf(blockNumber).getBytes();
|
||||
return HashUtil.sha3(data);
|
||||
}
|
||||
|
|
|
@ -6,9 +6,8 @@ import org.ethereum.util.ByteUtil;
|
|||
|
||||
/**
|
||||
* @author Roman Mandeleil
|
||||
* Created on: 09/01/2015 08:05
|
||||
* @since 09.01.2015
|
||||
*/
|
||||
|
||||
public class PrecompiledContracts {
|
||||
|
||||
private static ECRecover ecRecover = new ECRecover();
|
||||
|
|
|
@ -7,10 +7,8 @@ import org.spongycastle.util.encoders.Hex;
|
|||
import redis.clients.jedis.exceptions.JedisConnectionException;
|
||||
|
||||
/**
|
||||
* @author: Roman Mandeleil
|
||||
* Created on: 18/01/2015 22:40
|
||||
* @author Roman Mandeleil
|
||||
*/
|
||||
|
||||
public class RedisDataSourceTest {
|
||||
|
||||
|
||||
|
|
|
@ -11,10 +11,8 @@ import org.spongycastle.util.encoders.Hex;
|
|||
import static org.junit.Assert.*;
|
||||
|
||||
/**
|
||||
* @author: Roman Mandeleil
|
||||
* Created on: 09/01/2015 08:28
|
||||
* @author Roman Mandeleil
|
||||
*/
|
||||
|
||||
public class PrecompiledContractTest {
|
||||
|
||||
|
||||
|
|
Loading…
Reference in New Issue