javadoc fixes prior to the release

proximax-storage · Sep 3, 2019 · 832b9d3 · 832b9d3
1 parent aa6e60b
commit 832b9d3
Show file tree

Hide file tree

Showing 11 changed files with 118 additions and 105 deletions.
diff --git a/src/main/java/io/proximax/sdk/model/blockchain/BlockchainUpgrade.java b/src/main/java/io/proximax/sdk/model/blockchain/BlockchainUpgrade.java
@@ -18,8 +18,8 @@ public class BlockchainUpgrade {
    private final BlockchainVersion version;
 
    /**
-    * @param height
-    * @param version
+    * @param height the height at which specified version became required
+    * @param version the node version
     */
    public BlockchainUpgrade(BigInteger height, BlockchainVersion version) {
       this.height = height;

diff --git a/src/main/java/io/proximax/sdk/model/blockchain/BlockchainVersion.java b/src/main/java/io/proximax/sdk/model/blockchain/BlockchainVersion.java
@@ -26,10 +26,10 @@ public class BlockchainVersion {
    private final int build;
 
    /**
-    * @param major
-    * @param minor
-    * @param revision
-    * @param build
+    * @param major major version number
+    * @param minor minor version number
+    * @param revision revision
+    * @param build build
     */
    public BlockchainVersion(int major, int minor, int revision, int build) {
       // validate input is in range
@@ -85,7 +85,7 @@ public BigInteger getVersionValue() {
    /**
     * create new instance using the big integer of 8 bytes
     * 
-    * @param version
+    * @param version serialized version represented as one number
     * @return the version instance representing the version value
     */
    public static BlockchainVersion fromVersionValue(BigInteger version) {

diff --git a/src/main/java/io/proximax/sdk/model/transaction/LockFundsTransaction.java b/src/main/java/io/proximax/sdk/model/transaction/LockFundsTransaction.java
@@ -44,16 +44,16 @@ public class LockFundsTransaction extends Transaction {
    private final SignedTransaction signedTransaction;
 
    /**
-    * @param networkType
-    * @param version
-    * @param deadline
-    * @param maxFee
-    * @param signature
-    * @param signer
-    * @param transactionInfo
-    * @param mosaic
-    * @param duration
-    * @param signedTransaction
+    * @param networkType network type
+    * @param version transaction version. Use {@link EntityVersion#LOCK} for current version
+    * @param deadline transaction deadline
+    * @param maxFee transaction fee
+    * @param signature optional signature
+    * @param signer optional signer
+    * @param transactionInfo optional transaction info
+    * @param mosaic mosaic to lock
+    * @param duration number of blocks to hold lock for
+    * @param signedTransaction the transaction which will release the lock when confirmed
     */
    public LockFundsTransaction(NetworkType networkType, Integer version, TransactionDeadline deadline,
          BigInteger maxFee, Optional<String> signature, Optional<PublicAccount> signer,

diff --git a/src/main/java/io/proximax/sdk/model/transaction/ModifyAccountPropertyTransaction.java b/src/main/java/io/proximax/sdk/model/transaction/ModifyAccountPropertyTransaction.java
@@ -37,16 +37,18 @@ public abstract class ModifyAccountPropertyTransaction<T> extends Transaction {
    private final List<AccountPropertyModification<T>> modifications;
 
    /**
-    * @param type
-    * @param networkType
-    * @param version
-    * @param deadline
-    * @param maxFee
-    * @param signature
-    * @param signer
-    * @param transactionInfo
-    * @param propertyType
-    * @param modifications
+    * @param type transaction type
+    * @param networkType network type
+    * @param version transaction version. Use {@link EntityVersion#ACCOUNT_PROPERTIES_ADDRESS},
+    * {@link EntityVersion#ACCOUNT_PROPERTIES_MOSAIC}, {@link EntityVersion#ACCOUNT_PROPERTIES_ENTITY_TYPE} for current
+    * version
+    * @param deadline transaction deadline
+    * @param maxFee transaction fee
+    * @param signature optional signature
+    * @param signer optional signer
+    * @param transactionInfo optional transaction info
+    * @param propertyType type of the account property
+    * @param modifications modifications to the property type
     */
    public ModifyAccountPropertyTransaction(EntityType type, NetworkType networkType, Integer version,
          TransactionDeadline deadline, BigInteger maxFee, Optional<String> signature, Optional<PublicAccount> signer,
@@ -151,15 +153,15 @@ public static class AddressModification extends ModifyAccountPropertyTransaction
       private static final int VALUE_BYTES_LENGTH = 25;
 
       /**
-       * @param networkType
-       * @param version
-       * @param deadline
-       * @param maxFee
-       * @param signature
-       * @param signer
-       * @param transactionInfo
-       * @param propertyType
-       * @param modifications
+       * @param networkType network type
+       * @param version transaction version. Use {@link EntityVersion#ACCOUNT_PROPERTIES_ADDRESS} for current version
+       * @param deadline transaction deadline
+       * @param maxFee transaction fee
+       * @param signature optional signature
+       * @param signer optional signer
+       * @param transactionInfo optional transaction info
+       * @param propertyType type of the account property
+       * @param modifications modifications to the property type
        */
       public AddressModification(NetworkType networkType, Integer version, TransactionDeadline deadline,
             BigInteger maxFee, Optional<String> signature, Optional<PublicAccount> signer,
@@ -215,15 +217,15 @@ public static class MosaicModification extends ModifyAccountPropertyTransaction<
       private static final int VALUE_BYTES_LENGTH = 8;
 
       /**
-       * @param networkType
-       * @param version
-       * @param deadline
-       * @param maxFee
-       * @param signature
-       * @param signer
-       * @param transactionInfo
-       * @param propertyType
-       * @param modifications
+       * @param networkType network type
+       * @param version transaction version. Use {@link EntityVersion#ACCOUNT_PROPERTIES_MOSAIC} for current version
+       * @param deadline transaction deadline
+       * @param maxFee transaction fee
+       * @param signature optional signature
+       * @param signer optional signer
+       * @param transactionInfo optional transaction info
+       * @param propertyType type of the account property
+       * @param modifications modifications to the property type
        */
       public MosaicModification(NetworkType networkType, Integer version, TransactionDeadline deadline,
             BigInteger maxFee, Optional<String> signature, Optional<PublicAccount> signer,
@@ -278,22 +280,23 @@ public static class EntityTypeModification extends ModifyAccountPropertyTransact
       private static final int VALUE_BYTES_LENGTH = 2;
 
       /**
-       * @param networkType
-       * @param version
-       * @param deadline
-       * @param maxFee
-       * @param signature
-       * @param signer
-       * @param transactionInfo
-       * @param propertyType
-       * @param modifications
+       * @param networkType network type
+       * @param version transaction version. Use {@link EntityVersion#ACCOUNT_PROPERTIES_ENTITY_TYPE} for current
+       * version
+       * @param deadline transaction deadline
+       * @param maxFee transaction fee
+       * @param signature optional signature
+       * @param signer optional signer
+       * @param transactionInfo optional transaction info
+       * @param propertyType type of the account property
+       * @param modifications modifications to the property type
        */
       public EntityTypeModification(NetworkType networkType, Integer version, TransactionDeadline deadline,
             BigInteger maxFee, Optional<String> signature, Optional<PublicAccount> signer,
             Optional<TransactionInfo> transactionInfo, AccountPropertyType propertyType,
             List<AccountPropertyModification<EntityType>> modifications) {
-         super(EntityType.ACCOUNT_PROPERTIES_ENTITY_TYPE, networkType, version, deadline, maxFee, signature,
-               signer, transactionInfo, propertyType, modifications);
+         super(EntityType.ACCOUNT_PROPERTIES_ENTITY_TYPE, networkType, version, deadline, maxFee, signature, signer,
+               transactionInfo, propertyType, modifications);
       }
 
       @Override

diff --git a/src/main/java/io/proximax/sdk/model/transaction/ModifyMetadataTransaction.java b/src/main/java/io/proximax/sdk/model/transaction/ModifyMetadataTransaction.java
@@ -53,18 +53,18 @@ public class ModifyMetadataTransaction extends Transaction {
    private final List<MetadataModification> modifications;
 
    /**
-    * @param type
-    * @param networkType
-    * @param version
-    * @param deadline
-    * @param maxFee
-    * @param signature
-    * @param signer
-    * @param transactionInfo
-    * @param metadataType
-    * @param metadataId
-    * @param address
-    * @param modifications
+    * @param type transaction type ADDRESS / MOSAIC / NAMESPACE
+    * @param networkType network type
+    * @param version transaction version. Use {@link EntityVersion} for current version
+    * @param deadline transaction deadline
+    * @param maxFee transaction fee
+    * @param signature optional signature
+    * @param signer optional signer
+    * @param transactionInfo optional transaction info
+    * @param metadataType type of the metadata
+    * @param metadataId mosaic or namespace ID for which metadata is modified (used only when address is not specified)
+    * @param address address for which metadata is modified (only to be used when metadataId is not specified)
+    * @param modifications the modification to make
     */
    public ModifyMetadataTransaction(EntityType type, NetworkType networkType, Integer version,
          TransactionDeadline deadline, BigInteger maxFee, Optional<String> signature, Optional<PublicAccount> signer,

diff --git a/src/main/java/io/proximax/sdk/model/transaction/ModifyMultisigAccountTransaction.java b/src/main/java/io/proximax/sdk/model/transaction/ModifyMultisigAccountTransaction.java
@@ -54,7 +54,7 @@ public class ModifyMultisigAccountTransaction extends Transaction {
     * @param transactionInfo optional transaction info
     * @param minApprovalDelta minimum number of cosignatures for transaction approval
     * @param minRemovalDelta minimum number of cosignatures for cosignatory removal
-    * @param modifications
+    * @param modifications the modifications to the account
     */
    public ModifyMultisigAccountTransaction(NetworkType networkType, Integer version, TransactionDeadline deadline,
          BigInteger maxFee, Optional<String> signature, Optional<PublicAccount> signer,

diff --git a/src/main/java/io/proximax/sdk/model/transaction/MosaicDefinitionTransaction.java b/src/main/java/io/proximax/sdk/model/transaction/MosaicDefinitionTransaction.java
@@ -50,16 +50,16 @@ public class MosaicDefinitionTransaction extends Transaction {
    private final MosaicProperties mosaicProperties;
 
    /**
-    * @param networkType
-    * @param version
-    * @param deadline
-    * @param maxFee
-    * @param signature
-    * @param signer
-    * @param transactionInfo
-    * @param nonce
-    * @param mosaicId
-    * @param mosaicProperties
+    * @param networkType network type
+    * @param version transaction version. Use {@link EntityVersion#MOSAIC_DEFINITION} for current version
+    * @param deadline transaction deadline
+    * @param maxFee transaction fee
+    * @param signature optional signature
+    * @param signer optional signer
+    * @param transactionInfo optional transaction info
+    * @param nonce nonce used to generate unique mosaic ID
+    * @param mosaicId mosaic ID
+    * @param mosaicProperties mosaic properties
     */
    public MosaicDefinitionTransaction(NetworkType networkType, Integer version, TransactionDeadline deadline,
          BigInteger maxFee, Optional<String> signature, Optional<PublicAccount> signer,

diff --git a/src/main/java/io/proximax/sdk/model/transaction/MosaicSupplyChangeTransaction.java b/src/main/java/io/proximax/sdk/model/transaction/MosaicSupplyChangeTransaction.java
@@ -42,16 +42,16 @@ public class MosaicSupplyChangeTransaction extends Transaction {
    private final BigInteger delta;
 
    /**
-    * @param networkType
-    * @param version
-    * @param deadline
-    * @param maxFee
-    * @param signature
-    * @param signer
-    * @param transactionInfo
-    * @param mosaicId
-    * @param mosaicSupplyType
-    * @param delta
+    * @param networkType network type
+    * @param version transaction version. Use {@link EntityVersion#MOSAIC_SUPPLY_CHANGE} for current version
+    * @param deadline transaction deadline
+    * @param maxFee transaction fee
+    * @param signature optional signature
+    * @param signer optional signer
+    * @param transactionInfo optional transaction info
+    * @param mosaicId ID of mosaic that will change
+    * @param mosaicSupplyType type of the supply change (increase/decrease)
+    * @param delta the change to the supply
     */
    public MosaicSupplyChangeTransaction(NetworkType networkType, Integer version, TransactionDeadline deadline,
          BigInteger maxFee, Optional<String> signature, Optional<PublicAccount> signer,

diff --git a/src/main/java/io/proximax/sdk/model/transaction/RegisterNamespaceTransaction.java b/src/main/java/io/proximax/sdk/model/transaction/RegisterNamespaceTransaction.java
@@ -45,18 +45,18 @@ public class RegisterNamespaceTransaction extends Transaction {
 
 
    /**
-    * @param networkType
-    * @param version
-    * @param deadline
-    * @param maxFee
-    * @param signature
-    * @param signer
-    * @param transactionInfo
-    * @param namespaceName
-    * @param namespaceId
-    * @param duration
-    * @param parentId
-    * @param namespaceType
+    * @param networkType network type
+    * @param version transaction version. Use {@link EntityVersion#REGISTER_NAMESPACE} for current version
+    * @param deadline transaction deadline
+    * @param maxFee transaction fee
+    * @param signature optional signature
+    * @param signer optional signer
+    * @param transactionInfo optional transaction info
+    * @param namespaceName name of the namespace
+    * @param namespaceId id of the namespace (generated from name and optionally parent)
+    * @param duration number of blocks for which the namespace will exist
+    * @param parentId parent namespace ID for sub-namespaces
+    * @param namespaceType root or sub namespace
     */
    public RegisterNamespaceTransaction(NetworkType networkType, Integer version,
          TransactionDeadline deadline, BigInteger maxFee, Optional<String> signature, Optional<PublicAccount> signer,