From 878f5e9f95cbf79f07364de860c0aa8b154fc4d0 Mon Sep 17 00:00:00 2001 From: pinpong Date: Sun, 12 Feb 2017 23:36:47 +0100 Subject: [PATCH] documentation --- src/main/java/jota/IotaAPICore.java | 3 ++- src/main/java/jota/error/ArgumentException.java | 2 +- src/main/java/jota/error/BaseException.java | 2 +- src/main/java/jota/error/BroadcastAndStoreException.java | 2 +- src/main/java/jota/error/InvalidAddressException.java | 2 +- src/main/java/jota/error/InvalidBundleException.java | 2 +- src/main/java/jota/error/InvalidSecurityLevelException.java | 2 +- src/main/java/jota/error/InvalidSignatureException.java | 2 +- src/main/java/jota/error/InvalidTransferException.java | 2 +- src/main/java/jota/error/InvalidTrytesException.java | 2 +- src/main/java/jota/error/NoInclusionStatesExcpection.java | 2 +- src/main/java/jota/error/NoNodeInfoException.java | 2 +- src/main/java/jota/error/NotEnoughBalanceException.java | 2 +- src/main/java/jota/model/Bundle.java | 5 +++-- src/main/java/jota/model/Input.java | 5 +++-- src/main/java/jota/model/Inputs.java | 5 +++-- src/main/java/jota/model/Neighbor.java | 5 +++-- src/main/java/jota/model/Signature.java | 5 +++-- src/main/java/jota/model/Transaction.java | 3 ++- src/main/java/jota/model/Transfer.java | 3 ++- src/main/java/jota/pow/ICurl.java | 2 +- src/main/java/jota/utils/Checksum.java | 3 ++- src/main/java/jota/utils/Constants.java | 3 ++- src/main/java/jota/utils/InputValidator.java | 3 ++- src/main/java/jota/utils/IotaUnitConverter.java | 3 ++- src/main/java/jota/utils/IotaUnits.java | 1 + src/main/java/jota/utils/Multisig.java | 2 +- src/main/java/jota/utils/NamedThreadFactory.java | 2 +- src/main/java/jota/utils/Parallel.java | 2 +- src/main/java/jota/utils/SeedRandomGenerator.java | 3 ++- src/main/java/jota/utils/StopWatch.java | 2 +- src/main/java/jota/utils/TrytesConverter.java | 3 ++- src/test/java/jota/ChecksumTest.java | 2 +- src/test/java/jota/InputValidatorTest.java | 2 +- src/test/java/jota/IotaCoreApiTest.java | 2 +- src/test/java/jota/IotaUnitConverterTest.java | 2 +- src/test/java/jota/SeedRandomGeneratorTest.java | 2 +- src/test/java/jota/TrytesConverterTest.java | 2 +- 38 files changed, 57 insertions(+), 42 deletions(-) diff --git a/src/main/java/jota/IotaAPICore.java b/src/main/java/jota/IotaAPICore.java index 51524a1..7264b46 100644 --- a/src/main/java/jota/IotaAPICore.java +++ b/src/main/java/jota/IotaAPICore.java @@ -20,7 +20,8 @@ import java.util.Properties; import java.util.concurrent.TimeUnit; /** - * Created by Adrian on 15.01.2017. + * This class provides access to the Iota core API + * @author Adrian */ public class IotaAPICore { diff --git a/src/main/java/jota/error/ArgumentException.java b/src/main/java/jota/error/ArgumentException.java index 075d90e..fafb454 100644 --- a/src/main/java/jota/error/ArgumentException.java +++ b/src/main/java/jota/error/ArgumentException.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by Adrian on 09.12.2016. + * @author Adrian */ public class ArgumentException extends BaseException { diff --git a/src/main/java/jota/error/BaseException.java b/src/main/java/jota/error/BaseException.java index 972a0ac..bbfd5ea 100644 --- a/src/main/java/jota/error/BaseException.java +++ b/src/main/java/jota/error/BaseException.java @@ -5,7 +5,7 @@ import java.util.Arrays; import java.util.Collection; /** - * Created by Adrian on 09.12.2016. + * @author Adrian */ public class BaseException extends Exception { diff --git a/src/main/java/jota/error/BroadcastAndStoreException.java b/src/main/java/jota/error/BroadcastAndStoreException.java index a5b58e6..d5dbd52 100644 --- a/src/main/java/jota/error/BroadcastAndStoreException.java +++ b/src/main/java/jota/error/BroadcastAndStoreException.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by Adrian on 22.01.2017. + * @author Adrian */ public class BroadcastAndStoreException extends BaseException { diff --git a/src/main/java/jota/error/InvalidAddressException.java b/src/main/java/jota/error/InvalidAddressException.java index 442babf..b410951 100644 --- a/src/main/java/jota/error/InvalidAddressException.java +++ b/src/main/java/jota/error/InvalidAddressException.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by pinpong on 05.02.17. + * @author Adrian */ public class InvalidAddressException extends BaseException { public InvalidAddressException() { diff --git a/src/main/java/jota/error/InvalidBundleException.java b/src/main/java/jota/error/InvalidBundleException.java index 658011b..6d5017e 100644 --- a/src/main/java/jota/error/InvalidBundleException.java +++ b/src/main/java/jota/error/InvalidBundleException.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by Adrian on 27.12.2016. + * @author Adrian */ public class InvalidBundleException extends BaseException { diff --git a/src/main/java/jota/error/InvalidSecurityLevelException.java b/src/main/java/jota/error/InvalidSecurityLevelException.java index 263ffbd..d000376 100644 --- a/src/main/java/jota/error/InvalidSecurityLevelException.java +++ b/src/main/java/jota/error/InvalidSecurityLevelException.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by pinpong on 02.02.17. + * @author pinpong */ public class InvalidSecurityLevelException extends BaseException { diff --git a/src/main/java/jota/error/InvalidSignatureException.java b/src/main/java/jota/error/InvalidSignatureException.java index d8d5565..9a30602 100644 --- a/src/main/java/jota/error/InvalidSignatureException.java +++ b/src/main/java/jota/error/InvalidSignatureException.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by Adrian on 27.12.2016. + * @author Adrian */ public class InvalidSignatureException extends BaseException { public InvalidSignatureException() { diff --git a/src/main/java/jota/error/InvalidTransferException.java b/src/main/java/jota/error/InvalidTransferException.java index 20a6565..6d8e501 100644 --- a/src/main/java/jota/error/InvalidTransferException.java +++ b/src/main/java/jota/error/InvalidTransferException.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by pinpong on 05.02.17. + * @author pinpong */ public class InvalidTransferException extends BaseException { public InvalidTransferException() { diff --git a/src/main/java/jota/error/InvalidTrytesException.java b/src/main/java/jota/error/InvalidTrytesException.java index 8977f2f..c610afb 100644 --- a/src/main/java/jota/error/InvalidTrytesException.java +++ b/src/main/java/jota/error/InvalidTrytesException.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by Adrian on 04.02.2017. + * @author Adrian */ public class InvalidTrytesException extends BaseException { diff --git a/src/main/java/jota/error/NoInclusionStatesExcpection.java b/src/main/java/jota/error/NoInclusionStatesExcpection.java index c79ee4b..35fc61a 100644 --- a/src/main/java/jota/error/NoInclusionStatesExcpection.java +++ b/src/main/java/jota/error/NoInclusionStatesExcpection.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by Adrian on 22.01.2017. + * @author Adrian */ public class NoInclusionStatesExcpection extends BaseException { diff --git a/src/main/java/jota/error/NoNodeInfoException.java b/src/main/java/jota/error/NoNodeInfoException.java index 920c6f3..4df4ff8 100644 --- a/src/main/java/jota/error/NoNodeInfoException.java +++ b/src/main/java/jota/error/NoNodeInfoException.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by Adrian on 22.01.2017. + * @author Adrian */ public class NoNodeInfoException extends BaseException { diff --git a/src/main/java/jota/error/NotEnoughBalanceException.java b/src/main/java/jota/error/NotEnoughBalanceException.java index dfe44a1..a26d615 100644 --- a/src/main/java/jota/error/NotEnoughBalanceException.java +++ b/src/main/java/jota/error/NotEnoughBalanceException.java @@ -1,7 +1,7 @@ package jota.error; /** - * Created by Adrian on 09.12.2016. + * @author Adrian */ public class NotEnoughBalanceException extends BaseException { diff --git a/src/main/java/jota/model/Bundle.java b/src/main/java/jota/model/Bundle.java index 7c02db5..a878fc7 100644 --- a/src/main/java/jota/model/Bundle.java +++ b/src/main/java/jota/model/Bundle.java @@ -10,8 +10,9 @@ import java.util.List; /** - * Created by pinpong on 09.12.16. - */ + * This class represents a Bundle, a set of transactions + * @author pinpong + **/ public class Bundle implements Comparable { public static String EMPTY_HASH = "999999999999999999999999999999999999999999999999999999999999999999999999999999999"; diff --git a/src/main/java/jota/model/Input.java b/src/main/java/jota/model/Input.java index ead850c..f1e005a 100644 --- a/src/main/java/jota/model/Input.java +++ b/src/main/java/jota/model/Input.java @@ -4,8 +4,9 @@ import org.apache.commons.lang3.builder.ToStringBuilder; import org.apache.commons.lang3.builder.ToStringStyle; /** - * Created by Adrian on 09.12.2016. - */ + * This class represents an Input + * @author Adrian + **/ public class Input { private String address; private long balance; diff --git a/src/main/java/jota/model/Inputs.java b/src/main/java/jota/model/Inputs.java index 5d4b993..1485d81 100644 --- a/src/main/java/jota/model/Inputs.java +++ b/src/main/java/jota/model/Inputs.java @@ -5,8 +5,9 @@ import com.google.gson.Gson; import java.util.List; /** - * Created by Adrian on 09.12.2016. - */ + * This class represents an Inputs + * @author Adrian + **/ public class Inputs { private List inputsList; private long totalBalance; diff --git a/src/main/java/jota/model/Neighbor.java b/src/main/java/jota/model/Neighbor.java index 2eee719..fdd17ac 100644 --- a/src/main/java/jota/model/Neighbor.java +++ b/src/main/java/jota/model/Neighbor.java @@ -1,8 +1,9 @@ package jota.model; /** - * Created by pinpong on 02.12.16. - */ + * This class represents an Neighbor + * @author pinpong + **/ public class Neighbor { private String address; diff --git a/src/main/java/jota/model/Signature.java b/src/main/java/jota/model/Signature.java index 3e0a9ba..db5e12c 100644 --- a/src/main/java/jota/model/Signature.java +++ b/src/main/java/jota/model/Signature.java @@ -4,8 +4,9 @@ import java.util.ArrayList; import java.util.List; /** - * Created by Adrian on 27.12.2016. - */ + * This class represents an Signature + * @author Adrian + **/ public class Signature { String address; diff --git a/src/main/java/jota/model/Transaction.java b/src/main/java/jota/model/Transaction.java index 9b49bc8..b744040 100644 --- a/src/main/java/jota/model/Transaction.java +++ b/src/main/java/jota/model/Transaction.java @@ -12,7 +12,8 @@ import org.slf4j.LoggerFactory; import java.util.Arrays; /** - * Created by pinpong on 02.12.16. + * This class represents an iota transaction + * @author pinpong */ public class Transaction { private static final Logger log = LoggerFactory.getLogger(Transaction.class); diff --git a/src/main/java/jota/model/Transfer.java b/src/main/java/jota/model/Transfer.java index 65cb8de..645d2c3 100644 --- a/src/main/java/jota/model/Transfer.java +++ b/src/main/java/jota/model/Transfer.java @@ -3,7 +3,8 @@ package jota.model; import com.google.gson.Gson; /** - * Created by pinpong on 02.12.16. + * This class represents a Transfer + * @author pinpong */ public class Transfer { diff --git a/src/main/java/jota/pow/ICurl.java b/src/main/java/jota/pow/ICurl.java index 877a16d..0933ab1 100644 --- a/src/main/java/jota/pow/ICurl.java +++ b/src/main/java/jota/pow/ICurl.java @@ -1,7 +1,7 @@ package jota.pow; /** - * Created by Adrian on 07.01.2017. + * @author Adrian */ public interface ICurl { ICurl absorb(final int[] trits, int offset, int length); diff --git a/src/main/java/jota/utils/Checksum.java b/src/main/java/jota/utils/Checksum.java index bd2e542..e33bd21 100644 --- a/src/main/java/jota/utils/Checksum.java +++ b/src/main/java/jota/utils/Checksum.java @@ -4,7 +4,8 @@ import jota.error.InvalidAddressException; import jota.pow.JCurl; /** - * Created by pinpong on 02.12.16. + * This class defines utility methods to add/remove the checksum to/from an address + * @author pinpong */ public class Checksum { diff --git a/src/main/java/jota/utils/Constants.java b/src/main/java/jota/utils/Constants.java index 5f8f9a2..8a3a393 100644 --- a/src/main/java/jota/utils/Constants.java +++ b/src/main/java/jota/utils/Constants.java @@ -1,7 +1,8 @@ package jota.utils; /** - * Created by pinpong on 02.12.16. + * This class defines the global constants + * @author pinpong */ public class Constants { diff --git a/src/main/java/jota/utils/InputValidator.java b/src/main/java/jota/utils/InputValidator.java index 0399602..f1a2dea 100644 --- a/src/main/java/jota/utils/InputValidator.java +++ b/src/main/java/jota/utils/InputValidator.java @@ -8,7 +8,8 @@ import org.apache.commons.lang3.math.NumberUtils; import java.util.List; /** - * Created by pinpong on 02.12.16. + * This class provides methods to validate the parameters of different iota API methods + * @author pinpong */ public class InputValidator { diff --git a/src/main/java/jota/utils/IotaUnitConverter.java b/src/main/java/jota/utils/IotaUnitConverter.java index eade784..7b0635c 100644 --- a/src/main/java/jota/utils/IotaUnitConverter.java +++ b/src/main/java/jota/utils/IotaUnitConverter.java @@ -3,7 +3,8 @@ package jota.utils; import java.text.DecimalFormat; /** - * Created by Sascha on 30.11.16. + * This class provides methods to convert Iota to different units + * @author sascha */ public class IotaUnitConverter { diff --git a/src/main/java/jota/utils/IotaUnits.java b/src/main/java/jota/utils/IotaUnits.java index e799913..bb7bb09 100644 --- a/src/main/java/jota/utils/IotaUnits.java +++ b/src/main/java/jota/utils/IotaUnits.java @@ -2,6 +2,7 @@ package jota.utils; /** * Table of IOTA units based off of the standard system of Units + * @author pinpong **/ public enum IotaUnits { diff --git a/src/main/java/jota/utils/Multisig.java b/src/main/java/jota/utils/Multisig.java index 4456d1d..f2b07b4 100644 --- a/src/main/java/jota/utils/Multisig.java +++ b/src/main/java/jota/utils/Multisig.java @@ -7,7 +7,7 @@ import jota.pow.JCurl; import java.util.Arrays; /** - * Created by pinpong on 02.02.17. + * @author pinpong */ public class Multisig { diff --git a/src/main/java/jota/utils/NamedThreadFactory.java b/src/main/java/jota/utils/NamedThreadFactory.java index a6e3dab..4f92e1a 100644 --- a/src/main/java/jota/utils/NamedThreadFactory.java +++ b/src/main/java/jota/utils/NamedThreadFactory.java @@ -5,7 +5,7 @@ import java.util.concurrent.ThreadFactory; import java.util.concurrent.atomic.AtomicInteger; /** - * Created by Adrian on 15.01.2017. + * @author Adrian */ public class NamedThreadFactory implements ThreadFactory { private final String baseName; diff --git a/src/main/java/jota/utils/Parallel.java b/src/main/java/jota/utils/Parallel.java index f5cdeb7..3dccff4 100644 --- a/src/main/java/jota/utils/Parallel.java +++ b/src/main/java/jota/utils/Parallel.java @@ -8,7 +8,7 @@ import java.util.concurrent.ExecutorService; import java.util.concurrent.Executors; /** - * Created by Adrian on 15.01.2017. + * @author Adrian */ public class Parallel { private static final int NUM_CORES = Runtime.getRuntime().availableProcessors(); diff --git a/src/main/java/jota/utils/SeedRandomGenerator.java b/src/main/java/jota/utils/SeedRandomGenerator.java index 2727d8c..fd5b93a 100644 --- a/src/main/java/jota/utils/SeedRandomGenerator.java +++ b/src/main/java/jota/utils/SeedRandomGenerator.java @@ -3,7 +3,8 @@ package jota.utils; import java.security.SecureRandom; /** - * Created by pinpong on 13.12.16. + * This class allows to create a secure random generated seed + * @author pinpong */ public class SeedRandomGenerator { diff --git a/src/main/java/jota/utils/StopWatch.java b/src/main/java/jota/utils/StopWatch.java index 699de6f..18ec7bc 100644 --- a/src/main/java/jota/utils/StopWatch.java +++ b/src/main/java/jota/utils/StopWatch.java @@ -1,7 +1,7 @@ package jota.utils; /** - * Created by Adrian on 15.01.2017. + * @author adrian */ public class StopWatch { private long startTime = 0; diff --git a/src/main/java/jota/utils/TrytesConverter.java b/src/main/java/jota/utils/TrytesConverter.java index bea49ac..376167a 100644 --- a/src/main/java/jota/utils/TrytesConverter.java +++ b/src/main/java/jota/utils/TrytesConverter.java @@ -1,7 +1,8 @@ package jota.utils; /** - * Created by pinpong on 01.12.16. + * This class allows to convert between ASCII and tryte encoded strings + * @author pinpong */ public class TrytesConverter { diff --git a/src/test/java/jota/ChecksumTest.java b/src/test/java/jota/ChecksumTest.java index f2b950d..12ec896 100644 --- a/src/test/java/jota/ChecksumTest.java +++ b/src/test/java/jota/ChecksumTest.java @@ -7,7 +7,7 @@ import org.junit.Test; import static org.junit.Assert.assertEquals; /** - * Created by pinpong on 02.12.16. + * @author pinpong */ public class ChecksumTest { diff --git a/src/test/java/jota/InputValidatorTest.java b/src/test/java/jota/InputValidatorTest.java index 502ab47..244dacc 100644 --- a/src/test/java/jota/InputValidatorTest.java +++ b/src/test/java/jota/InputValidatorTest.java @@ -11,7 +11,7 @@ import java.util.List; import static org.junit.Assert.assertEquals; /** - * Created by pinpong on 02.12.16. + * @author pinpong */ public class InputValidatorTest { diff --git a/src/test/java/jota/IotaCoreApiTest.java b/src/test/java/jota/IotaCoreApiTest.java index d3aa4e8..36d8f44 100644 --- a/src/test/java/jota/IotaCoreApiTest.java +++ b/src/test/java/jota/IotaCoreApiTest.java @@ -9,7 +9,7 @@ import org.junit.Test; import static org.junit.Assert.assertThat; /** - * Created by Adrian on 15.01.2017. + * @author Adrian */ public class IotaCoreApiTest { diff --git a/src/test/java/jota/IotaUnitConverterTest.java b/src/test/java/jota/IotaUnitConverterTest.java index 624555a..a63e6de 100644 --- a/src/test/java/jota/IotaUnitConverterTest.java +++ b/src/test/java/jota/IotaUnitConverterTest.java @@ -7,7 +7,7 @@ import org.junit.Test; import static org.junit.Assert.assertEquals; /** - * Created by pinpong on 30.11.16. + * @author pinpong */ public class IotaUnitConverterTest { diff --git a/src/test/java/jota/SeedRandomGeneratorTest.java b/src/test/java/jota/SeedRandomGeneratorTest.java index 01c203f..0876dfe 100644 --- a/src/test/java/jota/SeedRandomGeneratorTest.java +++ b/src/test/java/jota/SeedRandomGeneratorTest.java @@ -8,7 +8,7 @@ import org.junit.Test; import static org.junit.Assert.assertEquals; /** - * Created by pinpong on 13.12.16. + * @author pinpong */ public class SeedRandomGeneratorTest { diff --git a/src/test/java/jota/TrytesConverterTest.java b/src/test/java/jota/TrytesConverterTest.java index f6403e5..9c65c4f 100644 --- a/src/test/java/jota/TrytesConverterTest.java +++ b/src/test/java/jota/TrytesConverterTest.java @@ -8,7 +8,7 @@ import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertTrue; /** - * Created by pinpong on 01.12.16. + * @author pinpong */ public class TrytesConverterTest {