diff --git a/convex-benchmarks/pom.xml b/convex-benchmarks/pom.xml index 51329c0b4..677b8e78b 100644 --- a/convex-benchmarks/pom.xml +++ b/convex-benchmarks/pom.xml @@ -4,7 +4,7 @@ world.convex convex - 0.7.13-SNAPSHOT + 0.7.13 4.0.0 diff --git a/convex-cli/pom.xml b/convex-cli/pom.xml index 58036b13c..51171f128 100644 --- a/convex-cli/pom.xml +++ b/convex-cli/pom.xml @@ -2,7 +2,7 @@ world.convex convex - 0.7.13-SNAPSHOT + 0.7.13 4.0.0 diff --git a/convex-cli/src/main/java/convex/cli/ACommand.java b/convex-cli/src/main/java/convex/cli/ACommand.java index eaa0461cf..2d5210e81 100644 --- a/convex-cli/src/main/java/convex/cli/ACommand.java +++ b/convex-cli/src/main/java/convex/cli/ACommand.java @@ -7,7 +7,7 @@ public abstract class ACommand implements Runnable { /** * Gets the current CLI main command instance - * @return + * @return CLI instance */ public abstract Main cli(); } diff --git a/convex-core/pom.xml b/convex-core/pom.xml index 571ba99c4..f59fdb93c 100644 --- a/convex-core/pom.xml +++ b/convex-core/pom.xml @@ -4,7 +4,7 @@ world.convex convex - 0.7.13-SNAPSHOT + 0.7.13 diff --git a/convex-core/src/main/java/convex/core/Block.java b/convex-core/src/main/java/convex/core/Block.java index 3dedbaef6..303eaf97f 100644 --- a/convex-core/src/main/java/convex/core/Block.java +++ b/convex-core/src/main/java/convex/core/Block.java @@ -150,7 +150,7 @@ public int estimatedEncodingSize() { /** * Read a Block from a Blob encoding - * @throws BadFormatException + * @throws BadFormatException In event of encoding error */ public static Block read(Blob b, int pos) throws BadFormatException { int epos=pos+1; // skip tag diff --git a/convex-core/src/main/java/convex/core/Receipt.java b/convex-core/src/main/java/convex/core/Receipt.java index b64f41d99..4c3067a75 100644 --- a/convex-core/src/main/java/convex/core/Receipt.java +++ b/convex-core/src/main/java/convex/core/Receipt.java @@ -68,7 +68,7 @@ private AVector> getLog() { /** * Gets the error code of this Receipt, or null if not an error - * @return + * @return Error code (probably a Keyword or nil) */ public ACell getErrorCode() { if (!isError) return null; @@ -77,7 +77,7 @@ public ACell getErrorCode() { /** * Gets the result value of this Receipt, or null if an error - * @return + * @return Result from this Receipt */ public ACell getResult() { if (isError) return null; diff --git a/convex-core/src/main/java/convex/core/Result.java b/convex-core/src/main/java/convex/core/Result.java index 2e1c8e6f2..a9f2239e2 100644 --- a/convex-core/src/main/java/convex/core/Result.java +++ b/convex-core/src/main/java/convex/core/Result.java @@ -258,7 +258,7 @@ public boolean isError() { /** * Constructs a Result from a Context * @param id Id for Result - * @param ctx Context + * @param rc ResultContext instance from which to extract Result * @return New Result instance */ diff --git a/convex-core/src/main/java/convex/core/State.java b/convex-core/src/main/java/convex/core/State.java index 49a8ab277..c065643d1 100644 --- a/convex-core/src/main/java/convex/core/State.java +++ b/convex-core/src/main/java/convex/core/State.java @@ -312,8 +312,8 @@ public BlockResult applyBlock(SignedData signedBlock) { /** * Checks if a block is valid for application to the current state - * @param signedBlock - * @return + * @param signedBlock Signed Block + * @return BlockResult instance if an error occurred, or nil if checks pass */ public BlockResult checkBlock(SignedData signedBlock) { Block block=signedBlock.getValue(); @@ -544,7 +544,7 @@ private ResultContext createResultContext(ATransaction t) { * * There are three phases in application of a transaction: *
    - *
  1. Preparation for accounting, with {@link #prepareTransaction(ATransaction) prepareTransaction}
    2. + *
  2. Preparation for accounting, with {@link #prepareTransaction(ResultContext) prepareTransaction}
    3. *
  3. Functional application of the transaction with ATransaction.apply(....)
    4. *
  4. Completion of accounting, with completeTransaction
    5. *
diff --git a/convex-core/src/main/java/convex/core/crypto/BIP39.java b/convex-core/src/main/java/convex/core/crypto/BIP39.java index 0defd216e..179c17df5 100644 --- a/convex-core/src/main/java/convex/core/crypto/BIP39.java +++ b/convex-core/src/main/java/convex/core/crypto/BIP39.java @@ -226,8 +226,6 @@ public class BIP39 { * @param words Mnemonic words * @param passphrase Optional BIP39 passphrase * @return Blob containing BIP39 seed (64 bytes) - * @throws NoSuchAlgorithmException - * @throws InvalidKeySpecException */ public static Blob getSeed(List words, String passphrase) throws NoSuchAlgorithmException, InvalidKeySpecException { if (passphrase==null) passphrase=""; @@ -264,7 +262,7 @@ public static Blob seedToEd25519Seed(Blob seed) { /** * Return true if the string is a valid mnemonic phrase - * @param menemonic + * @param s String to be tested as a mnemonic phrase * @return String containing reason that mnemonic is not valid, or null if OK */ public static String checkMnemonic(String s) { @@ -278,8 +276,6 @@ public static String checkMnemonic(String s) { * @param mnemonic Mnemonic words * @param passphrase Optional BIP39 passphrase * @return Blob containing BIP39 seed (64 bytes) - * @throws NoSuchAlgorithmException - * @throws InvalidKeySpecException */ public static Blob getSeed(String mnemonic, String passphrase) { mnemonic=normalise(mnemonic); diff --git a/convex-core/src/main/java/convex/core/crypto/Ed25519Signature.java b/convex-core/src/main/java/convex/core/crypto/Ed25519Signature.java index 6274895d7..d823c77e0 100644 --- a/convex-core/src/main/java/convex/core/crypto/Ed25519Signature.java +++ b/convex-core/src/main/java/convex/core/crypto/Ed25519Signature.java @@ -47,7 +47,7 @@ public static Ed25519Signature wrap(byte[] signature) { /** * Creates a Signature instance with specific bytes - * @param signature Bytes for signature + * @param data Bytes for signature * @return Signature instance */ public static Ed25519Signature wrap(byte[] data, int pos) { diff --git a/convex-core/src/main/java/convex/core/crypto/PFXTools.java b/convex-core/src/main/java/convex/core/crypto/PFXTools.java index f689d598f..e8b88f360 100644 --- a/convex-core/src/main/java/convex/core/crypto/PFXTools.java +++ b/convex-core/src/main/java/convex/core/crypto/PFXTools.java @@ -27,7 +27,7 @@ public class PFXTools { /** * Creates a new PKCS12 key store. * @param keyFile File to use for creating the key store - * @param passPhrase Passphrase used to protect the key store, may be null + * @param storePassword Passphrase used to protect the key store, may be null * @return New KeyStore instance */ public static KeyStore createStore(File keyFile, char[] storePassword) throws GeneralSecurityException, IOException { @@ -85,7 +85,7 @@ public static KeyStore saveStore(KeyStore ks, File keyFile, char[] storePassword * Retrieves a key pair from a key store. * @param ks Key store * @param alias Alias used for finding the key pair in the store - * @param passphrase Passphrase used for decrypting the key pair. Mandatory. + * @param keyPassword Passphrase used for decrypting the key pair. Mandatory. * @return Found key pair * @throws UnrecoverableKeyException If key cannot be recovered * @throws KeyStoreException If a general key store exception occurs @@ -116,7 +116,7 @@ public static KeyStore setKeyPair(KeyStore ks, AKeyPair kp, char[] keyPassword) * @param ks Key store * @param alias Alias entry for keystore * @param kp Key pair - * @param passPhrase Passphrase for encrypting the key pair. Mandatory. + * @param keyPassword Password for encrypting the key pair. Mandatory. * @return Updated key store. * @throws IOException If an IO error occurs accessing the key store * @throws GeneralSecurityException if a security exception occurs diff --git a/convex-core/src/main/java/convex/core/crypto/SLIP10.java b/convex-core/src/main/java/convex/core/crypto/SLIP10.java index ebbacaf60..5a9830ee3 100644 --- a/convex-core/src/main/java/convex/core/crypto/SLIP10.java +++ b/convex-core/src/main/java/convex/core/crypto/SLIP10.java @@ -2,8 +2,6 @@ import java.nio.charset.StandardCharsets; import java.security.GeneralSecurityException; -import java.security.InvalidKeyException; -import java.security.NoSuchAlgorithmException; import javax.crypto.Mac; import javax.crypto.spec.SecretKeySpec; @@ -30,8 +28,6 @@ public class SLIP10 { * Gets the the master key for a given seed according to SLIP10 * @param seed BIP39 seed value (or other source of good entropy!) * @return Blob containing the seed (bip39 seed, or some other good entropy source) - * @throws NoSuchAlgorithmException - * @throws InvalidKeyException */ public static Blob getMaster(Blob seed) { try { diff --git a/convex-core/src/main/java/convex/core/crypto/wallet/IWalletEntry.java b/convex-core/src/main/java/convex/core/crypto/wallet/IWalletEntry.java index 1c0e2af12..07fceb117 100644 --- a/convex-core/src/main/java/convex/core/crypto/wallet/IWalletEntry.java +++ b/convex-core/src/main/java/convex/core/crypto/wallet/IWalletEntry.java @@ -7,7 +7,7 @@ public interface IWalletEntry { /** * Check if this wallet entry is locked. - * @return + * @return True if wallet is locked */ public boolean isLocked(); @@ -19,12 +19,13 @@ public interface IWalletEntry { /** * Get the public key associated with this wallet entry - * @return + * @return Public Key */ AccountKey getPublicKey(); /** * Try to unlock a wallet with the given password + * @param password Password to unlock * * @return true if unlocked, false otherwise */ @@ -32,14 +33,13 @@ public interface IWalletEntry { /** * Unlock the wallet entry. Unlocking makes the entry usable for signing - * @param passPhrase - * @return + * @param password Unlock password */ - public void unlock(char[] passPhrase); + public void unlock(char[] password); /** * Lock the wallet entry. Locking makes the wallet entry unusable until unlocked. - * @param password + * @param password Password with which to lock wallet */ public void lock(char[] password); diff --git a/convex-core/src/main/java/convex/core/data/ADataStructure.java b/convex-core/src/main/java/convex/core/data/ADataStructure.java index 7d34ff07b..7448ae01c 100644 --- a/convex-core/src/main/java/convex/core/data/ADataStructure.java +++ b/convex-core/src/main/java/convex/core/data/ADataStructure.java @@ -60,7 +60,6 @@ public final boolean isEmpty() { * Adds an element to this data structure, in the natural manner defined by the * general data structure type. e.g. append at the end of a vector. * - * @param Type of Value added * @param x New element to add * @return The updated data structure, or null if a failure occurred due to invalid element type */ @@ -72,7 +71,6 @@ public final boolean isEmpty() { * * This may be more efficient than using 'conj' for individual items. * - * @param Type of Value added * @param xs New elements to add * @return The updated data structure, or null if a failure occurred due to invalid element types */ diff --git a/convex-core/src/main/java/convex/core/data/AVector.java b/convex-core/src/main/java/convex/core/data/AVector.java index 32e7b6e37..2030ea6c8 100644 --- a/convex-core/src/main/java/convex/core/data/AVector.java +++ b/convex-core/src/main/java/convex/core/data/AVector.java @@ -66,7 +66,7 @@ public AType getType() { * Appends a ListVector chunk to this vector. This vector must contain a whole * number of chunks * - * @param listVector A chunk to append. Must be a ListVector of maximum size + * @param chunk A chunk to append. Must be a ListVector of maximum size * @return The updated vector, of the same type as this vector @ */ public abstract AVector appendChunk(AVector chunk); diff --git a/convex-core/src/main/java/convex/core/data/Cells.java b/convex-core/src/main/java/convex/core/data/Cells.java index bc16fffec..a3f0ce18b 100644 --- a/convex-core/src/main/java/convex/core/data/Cells.java +++ b/convex-core/src/main/java/convex/core/data/Cells.java @@ -81,11 +81,11 @@ public static int branchCount(ACell a) { /** * Gets a Ref from a Cell by index - * @param + * @param Type of cell * @param cell Cell to read Ref from * @param index Numerical index of Ref * @throws IndexOutOfBoundsException if the index is out of range for the Cell - * @return + * @return Ref for cell */ public static Ref getRef(ACell cell, int index) { if (cell ==null) throw new IndexOutOfBoundsException("Bad ref index called on null"); @@ -126,7 +126,6 @@ public static boolean isValue(ACell a) { * Persist a cell in the current store * @param a Cell to persist * @return Cell after persisting (may be the same Cell if no change in cell hierarchy) - * @throws MissingDataException if the cell cannot be fully persisted due to missing data */ public static T persist(T a) { return persist(a,Stores.current()); @@ -137,7 +136,6 @@ public static T persist(T a) { * @param a Cell to persist * @param store Store instance to persist in * @return Cell after persisting (may be the same Cell if no change in cell hierarchy) - * @throws MissingDataException if the cell cannot be fully persisted due to missing data */ public static T persist(T a, AStore store) { Ref ref=Ref.get(a); @@ -150,7 +148,6 @@ public static T persist(T a, AStore store) { * @param a Cell to persist * @param store Store instance to persist in * @return Cell after persisting (may be the same Cell if no change in cell hierarchy) - * @throws MissingDataException if the cell cannot be fully persisted due to missing data */ public static T store(T a, AStore store) { Ref ref=Ref.get(a); @@ -163,7 +160,6 @@ public static T store(T a, AStore store) { * @param a Cell to announce * @param noveltyHandler Handler for novelty values * @return Cell after announcing (may be the same Cell if no change in cell hierarchy) - * @throws MissingDataException if the cell cannot be fully persisted due to missing data */ public static T announce(T a, Consumer> noveltyHandler) { if (a==null) { @@ -190,8 +186,8 @@ public static ABlobLike getEncoding(ACell a) { /** * Get the full storage size of a value, including size of an embedded encoding - * @param a - * @return + * @param a Cell to get size for (may be null) + * @return Storage size */ public static long storageSize(ACell a) { if (a==null) return 1; diff --git a/convex-core/src/main/java/convex/core/data/Format.java b/convex-core/src/main/java/convex/core/data/Format.java index f3f455f11..9f5414ce7 100644 --- a/convex-core/src/main/java/convex/core/data/Format.java +++ b/convex-core/src/main/java/convex/core/data/Format.java @@ -798,7 +798,7 @@ public static int estimateEncodingSize(ACell cell) { * Decodes an array of Cells packed in a Blob. Cells may be partial. * @param data Data containing cell encodings in multi-cell format * @return Array of decoded cells - * @throws BadFormatException + * @throws BadFormatException In event of any encoding error detected */ public static ACell[] decodeCells(Blob data) throws BadFormatException { long ml=data.count(); diff --git a/convex-core/src/main/java/convex/core/data/Index.java b/convex-core/src/main/java/convex/core/data/Index.java index 8cc417326..290702dff 100644 --- a/convex-core/src/main/java/convex/core/data/Index.java +++ b/convex-core/src/main/java/convex/core/data/Index.java @@ -265,7 +265,7 @@ public Index dissoc(K k) { * Tests if two keys match (up to the maximum index key depth) * @param a First key * @param b second key - * @return + * @return True if keys match */ public static >boolean keyMatch(K a, K b) { long n=a.count(); diff --git a/convex-core/src/main/java/convex/core/data/Ref.java b/convex-core/src/main/java/convex/core/data/Ref.java index 6213b7170..3a7f122f2 100644 --- a/convex-core/src/main/java/convex/core/data/Ref.java +++ b/convex-core/src/main/java/convex/core/data/Ref.java @@ -619,7 +619,7 @@ public long getMemorySize() { /** * Finds all instances of missing data in this Ref, and adds them to the missing set * @param missingSet Set to add missing instances to - * @param limit + * @param limit Maximum number of missing branches to identity */ public void findMissing(HashSet missingSet, long limit) { if (getStatus()>=Ref.PERSISTED) return; diff --git a/convex-core/src/main/java/convex/core/data/SignedData.java b/convex-core/src/main/java/convex/core/data/SignedData.java index b91213cc1..571cdf4b7 100644 --- a/convex-core/src/main/java/convex/core/data/SignedData.java +++ b/convex-core/src/main/java/convex/core/data/SignedData.java @@ -245,7 +245,8 @@ public boolean checkSignature() { /** * Validates the signature in this SignedData instance. Caches result - * + * + * @param publicKey Public key to check against this signature * @return true if valid, false otherwise */ public boolean checkSignature(AccountKey publicKey) { diff --git a/convex-core/src/main/java/convex/core/data/VectorArray.java b/convex-core/src/main/java/convex/core/data/VectorArray.java index 349b2c2bc..a40929cb6 100644 --- a/convex-core/src/main/java/convex/core/data/VectorArray.java +++ b/convex-core/src/main/java/convex/core/data/VectorArray.java @@ -17,7 +17,7 @@ * * Directly wraps an array of cells, considered effectively immutable * - * @param + * @param Type of vector elements */ public class VectorArray extends ASpecialVector { diff --git a/convex-core/src/main/java/convex/core/data/prim/AInteger.java b/convex-core/src/main/java/convex/core/data/prim/AInteger.java index 0156e2591..535f0a3bf 100644 --- a/convex-core/src/main/java/convex/core/data/prim/AInteger.java +++ b/convex-core/src/main/java/convex/core/data/prim/AInteger.java @@ -184,7 +184,7 @@ public static AInteger create(Number value) { /** * Raise the integer to the given power - * @param power + * @param power Power to raise integer to * @return Result, or null if invalid */ public AInteger toPower(AInteger power) { diff --git a/convex-core/src/main/java/convex/core/data/prim/CVMChar.java b/convex-core/src/main/java/convex/core/data/prim/CVMChar.java index 4f03b4710..25a2e084c 100644 --- a/convex-core/src/main/java/convex/core/data/prim/CVMChar.java +++ b/convex-core/src/main/java/convex/core/data/prim/CVMChar.java @@ -75,7 +75,7 @@ public static CVMChar create(long value) { /** * Gets a {@link CVMChar} from a UTF-8 representation - * @param value UTF-8 representation of a single character + * @param b Representation of a single character (UTF-8) * @return CVMChar instance, or null if not valid */ public static CVMChar fromUTF8(ABlobLike b) { diff --git a/convex-core/src/main/java/convex/core/lang/Context.java b/convex-core/src/main/java/convex/core/lang/Context.java index e95c02455..df09ec5b7 100644 --- a/convex-core/src/main/java/convex/core/lang/Context.java +++ b/convex-core/src/main/java/convex/core/lang/Context.java @@ -319,7 +319,6 @@ public static Context createInitial(State state, Address origin,long juiceLimit) *
  • Accumulates used juice fees in globals
    • *
  • Increments sequence number
    • * - * @param t * * @param initialState State before transaction execution (after prepare) * @param rc Juice price of current execution @@ -634,7 +633,7 @@ private Address getParentAddress(AccountStatus as) { /** * Looks up value for the given symbol in this context - * @param sym Symbol name to look up, as a Java String for convenience + * @param symName Symbol name to look up, as a Java String for convenience * @return Value for the given symbol or null if undeclared */ @SuppressWarnings("unchecked") @@ -1320,9 +1319,9 @@ public Context eval(ACell form) { /** * Executes an op as a top level instruction (no local bindings) - * @param - * @param op - * @return + * @param Type of Op result + * @param op Op to execute + * @return Updated Context */ public Context exec(AOp op) { AVector savedBindings = getLocalBindings(); diff --git a/convex-core/src/main/java/convex/core/lang/Core.java b/convex-core/src/main/java/convex/core/lang/Core.java index 0ed023374..443210af6 100644 --- a/convex-core/src/main/java/convex/core/lang/Core.java +++ b/convex-core/src/main/java/convex/core/lang/Core.java @@ -2940,9 +2940,9 @@ private static Context applyDocumentation(Context ctx) throws IOException { /** * Read a Core definition from an encoding * @param b Blob containing encoding - * @param pos Position to read + * @param pos Position to read Core code function * @return Singleton cell representing the Core value - * @throws BadFormatException + * @throws BadFormatException In case of encoding error */ public static ACell read(Blob b, int pos) throws BadFormatException { long code=Format.readVLCCount(b, pos+1); diff --git a/convex-core/src/main/java/convex/core/lang/Juice.java b/convex-core/src/main/java/convex/core/lang/Juice.java index e9eb29927..247e81aa0 100644 --- a/convex-core/src/main/java/convex/core/lang/Juice.java +++ b/convex-core/src/main/java/convex/core/lang/Juice.java @@ -504,7 +504,7 @@ public static long precostNumericMultiply(ACell[] args) { /** * Gets the base cost for a numeric argument, basically the length in bytes (min 8) - * @param aCell + * @param a Cell, presumably a number * @return base cost, or negative if not numeric */ public static long costNumeric(ACell a) { @@ -530,8 +530,8 @@ public static long calcAvailable(long balance, long juicePrice) { /** * Calculate price for memory size, mainly used for transaction overhead cost - * @param a - * @return + * @param a Cell to price + * @return Juice price for memory size */ public static long priceMemorySize(ACell a) { return Juice.mul(Juice.TRANSACTION_PER_BYTE, Cells.storageSize(a)); diff --git a/convex-core/src/main/java/convex/core/lang/Reader.java b/convex-core/src/main/java/convex/core/lang/Reader.java index 1c8459b3a..8adb6309f 100644 --- a/convex-core/src/main/java/convex/core/lang/Reader.java +++ b/convex-core/src/main/java/convex/core/lang/Reader.java @@ -21,7 +21,7 @@ public class Reader { /** * Parses an expression and returns a Syntax object * - * @param source + * @param source Source to read as a Syntax object * @return Parsed form */ public static Syntax readSyntax(String source) { @@ -44,10 +44,10 @@ public static ACell readResourceAsData(String path) throws IOException { } /** - * Parses an expression list and returns a list of raw forms + * Parses an String to returns a list of raw forms * - * @param source - * @return List of Syntax Objects + * @param source Convex data to read + * @return List of forms read */ public static AList readAll(String source) { return AntlrReader.readAll(source); diff --git a/convex-core/src/main/java/convex/core/lang/impl/ICoreDef.java b/convex-core/src/main/java/convex/core/lang/impl/ICoreDef.java index 4ea672775..cf0528031 100644 --- a/convex-core/src/main/java/convex/core/lang/impl/ICoreDef.java +++ b/convex-core/src/main/java/convex/core/lang/impl/ICoreDef.java @@ -24,7 +24,7 @@ public interface ICoreDef { /** * Gets the core definition code for this value - * @return + * @return Code definition code */ public int getCoreCode(); diff --git a/convex-core/src/main/java/convex/core/lang/ops/Do.java b/convex-core/src/main/java/convex/core/lang/ops/Do.java index 1363045f0..daf39f64f 100644 --- a/convex-core/src/main/java/convex/core/lang/ops/Do.java +++ b/convex-core/src/main/java/convex/core/lang/ops/Do.java @@ -81,7 +81,7 @@ public byte opCode() { /** * Decodes a Do op from a Blob encoding * - * @param + * @param Return type of Do * @param b Blob to read from * @param pos Start position in Blob (location of tag byte) * @return New decoded instance diff --git a/convex-core/src/main/java/convex/core/text/Text.java b/convex-core/src/main/java/convex/core/text/Text.java index 1f3fa02bc..c33da6064 100644 --- a/convex-core/src/main/java/convex/core/text/Text.java +++ b/convex-core/src/main/java/convex/core/text/Text.java @@ -87,8 +87,8 @@ public static String toFriendlyIntString(double value) { /** * Format function for Convex Coin balances - * @param balance - * @return + * @param balance Balance in Convex Coins + * @return Formatted String like "12.000567123" */ public static String toFriendlyBalance(long balance) { if (!Coin.isValidAmount(balance)) throw new IllegalArgumentException("Invalid balance)"); @@ -159,9 +159,9 @@ public static int columnCount(String text) { /** * Zero pads a positive integer out to the specified number of digits - * @param change - * @param digits - * @return + * @param b Integer to pad + * @param digits Number of digits desired + * @return String representation of Integer */ public static String zeroPad(BigInteger b, int digits) { if (digits>9) throw new IllegalArgumentException("Too many digits!!"); diff --git a/convex-core/src/main/java/convex/core/util/ThreadUtils.java b/convex-core/src/main/java/convex/core/util/ThreadUtils.java index 44a31cce3..7c0632f00 100644 --- a/convex-core/src/main/java/convex/core/util/ThreadUtils.java +++ b/convex-core/src/main/java/convex/core/util/ThreadUtils.java @@ -20,7 +20,7 @@ public class ThreadUtils { /** * Get the current virtual thread ExecutorService, intended for IO-bound blocking operations - * @return + * @return Executor service */ public synchronized static ExecutorService getVirtualExecutor() { if (virtualExecutor==null) { @@ -75,8 +75,6 @@ public static ArrayList> futureMap(ExecutorService ex * Awaits the result of all of a collection of futures * @param Type of futures * @param futures A collection of futures - * @throws InterruptedException - * @throws ExecutionException */ public static void awaitAll(Collection> futures) throws InterruptedException, ExecutionException { CompletableFuture.allOf(futures.toArray(new CompletableFuture[futures.size()])).get(); diff --git a/convex-core/src/main/java/convex/core/util/Utils.java b/convex-core/src/main/java/convex/core/util/Utils.java index 1a2e00b8c..24dc0e3f8 100644 --- a/convex-core/src/main/java/convex/core/util/Utils.java +++ b/convex-core/src/main/java/convex/core/util/Utils.java @@ -71,7 +71,7 @@ public static BigInteger toSignedBigInteger(byte[] data) { * * @param file File object to see if the path part of the filename exists, if not then create it. * @return target File, as an absolute path, with parent directories created recursively if needed - * @throws IOException + * @throws IOException In case of IO Error */ public static File ensurePath(File file) throws IOException { // Get path of parent directory, using absolute path (may be current working directory user.dir) @@ -83,8 +83,8 @@ public static File ensurePath(File file) throws IOException { /** * Gets the absolute path File for a given file name. Interprets leading "~" as user home directory. - * @param filename - * @return + * @param path Path as a string + * @return File representing the given path */ public static File getPath(String path) { if (path!=null && path.startsWith("~")) { @@ -434,7 +434,7 @@ public static boolean arrayEquals(byte[] a, int aOffset, byte[] b, int bOffset, * @param a First array * @param b Second array * @param n Number of elements to check - * @return + * @return True iff arrays are equal up to the specified element */ public static boolean arrayEquals(T[] a, T[] b, int n) { for (int i=0 ; i node) { /** * Navigate down a path relative to a DLFS Node. - * @param node - * @param path + * @param node Node from which to navigate + * @param path Path to navigate from (assumed to be relative) * @return Found node, or null if doesn't exist */ @SuppressWarnings("unchecked") @@ -69,7 +69,7 @@ public static AVector navigate(AVector node, DLPath path) { /** * Gets the directory entries for a node - * @param dirNode + * @param dirNode Node which is assumed to be a directory * @return Map of directory entries, or null if not a directory */ @SuppressWarnings("unchecked") @@ -80,7 +80,7 @@ public static AHashMap> getDirectoryEntries(AVector options, FileAttribute[] attrs) throws IOException; /** * Implementation for delegation by DLFSProvider - * @return + * @return Directory stream */ public abstract DLDirectoryStream newDirectoryStream(DLPath dir, Filter filter); @@ -191,7 +192,7 @@ public DLFSFileAttributes getFileAttributes(DLPath path) { /** * Gets DLFS node for the given path - * @param path + * @param path Path for which to obtain DLFSNode * @return DLFS node, or null if does not exist */ public abstract AVector getNode(DLPath path); @@ -222,16 +223,16 @@ public Hash getNodeHash(DLPath p) { /** * Creates a file, returning the new node - * @param path - * @return - * @throws IOException + * @param path Path for which to create DLFSNode + * @return New file node + * @throws IOException In event of IOError */ public abstract AVector createFile(DLPath path) throws IOException; /** * Updates a node, returning the new node - * @param path - * @param newNode + * @param path Path for which to update DLFSNode + * @param newNode NEw node to put in place * @return The new node */ public abstract AVector updateNode(DLPath path, AVector newNode); diff --git a/convex-core/src/main/java/etch/Etch.java b/convex-core/src/main/java/etch/Etch.java index 87b8d7abe..de61be936 100644 --- a/convex-core/src/main/java/etch/Etch.java +++ b/convex-core/src/main/java/etch/Etch.java @@ -631,6 +631,7 @@ protected void writeDataLength() throws IOException { /** * Gets the Etch version associated with this file + * @return Return Etch version number */ public short getVersion() { // TODO: Override when we have more versions @@ -639,8 +640,8 @@ public short getVersion() { /** * Gets the raw pointer for, given the slot value (clears high bits) - * @param slotValue - * @return + * @param slotValue Value in slot + * @return Pointer extracted from slot value */ public long rawPointer(long slotValue) { return slotValue&~TYPE_MASK; @@ -717,7 +718,7 @@ public RefSoft read(AArrayBlob key) throws IOException { * @param Type of Cell expected * @param ptr Pointer offset into Etch file. Type flags are ignored. * @return Cell value (may be null) - * @throws IOException + * @throws IOException In event of IO Error */ @SuppressWarnings("unchecked") public T readCell(long ptr) throws IOException { diff --git a/convex-core/src/test/java/convex/core/crypto/BIP39Test.java b/convex-core/src/test/java/convex/core/crypto/BIP39Test.java index 11c9cafe8..8fc14575f 100644 --- a/convex-core/src/test/java/convex/core/crypto/BIP39Test.java +++ b/convex-core/src/test/java/convex/core/crypto/BIP39Test.java @@ -36,8 +36,6 @@ public void testSeed() throws NoSuchAlgorithmException, InvalidKeySpecException /** * Test vector from https://iancoleman.io/bip39/ - * @throws NoSuchAlgorithmException - * @throws InvalidKeySpecException */ @Test public void testExample15() throws NoSuchAlgorithmException, InvalidKeySpecException { diff --git a/convex-core/src/test/java/convex/core/lang/ACVMTest.java b/convex-core/src/test/java/convex/core/lang/ACVMTest.java index b5e46bb8a..1ea175ef6 100644 --- a/convex-core/src/test/java/convex/core/lang/ACVMTest.java +++ b/convex-core/src/test/java/convex/core/lang/ACVMTest.java @@ -194,7 +194,6 @@ public long evalL(String source) { /** * Executes code in the given context and converts to a String - * @param ctx Context in which to execute * @param source Code to execute * @return Result of execution */ @@ -214,7 +213,6 @@ public T eval(ACell form) { /** * Executes code in the given context, asserting no errors - * @param ctx Context in which to execute * @param source Code to execute * @return Result of execution */ diff --git a/convex-gui/pom.xml b/convex-gui/pom.xml index 4e01113e3..738f9b400 100644 --- a/convex-gui/pom.xml +++ b/convex-gui/pom.xml @@ -4,7 +4,7 @@ world.convex convex - 0.7.13-SNAPSHOT + 0.7.13 4.0.0 diff --git a/convex-gui/src/main/java/convex/gui/components/CodePane.java b/convex-gui/src/main/java/convex/gui/components/CodePane.java index 3794dafba..af343f613 100644 --- a/convex-gui/src/main/java/convex/gui/components/CodePane.java +++ b/convex-gui/src/main/java/convex/gui/components/CodePane.java @@ -26,7 +26,7 @@ public CodePane() { /** * Gets the length of this document - * @return + * @return Document length */ public int docLength() { return getDocument().getLength(); diff --git a/convex-gui/src/main/java/convex/gui/keys/KeyRingPanel.java b/convex-gui/src/main/java/convex/gui/keys/KeyRingPanel.java index 34cb7a3ef..5643bde8c 100644 --- a/convex-gui/src/main/java/convex/gui/keys/KeyRingPanel.java +++ b/convex-gui/src/main/java/convex/gui/keys/KeyRingPanel.java @@ -126,7 +126,7 @@ public static AWalletEntry findWalletEntry(Convex convex) { /** * Gets an entry for the current keyring - * @param address + * @param publicKey Public key to search for * @return Wallet Entry, or null if not found */ public static AWalletEntry getKeyRingEntry(AccountKey publicKey) { diff --git a/convex-java/pom.xml b/convex-java/pom.xml index f8591231f..4d0d96217 100644 --- a/convex-java/pom.xml +++ b/convex-java/pom.xml @@ -5,7 +5,7 @@ world.convex convex - 0.7.13-SNAPSHOT + 0.7.13 Convex Java Client Library diff --git a/convex-observer/pom.xml b/convex-observer/pom.xml index 21f7bfe24..705981408 100644 --- a/convex-observer/pom.xml +++ b/convex-observer/pom.xml @@ -8,7 +8,7 @@ world.convex convex - 0.7.13-SNAPSHOT + 0.7.13 Convex Observer @@ -49,7 +49,7 @@ world.convex convex-java - 0.7.13-SNAPSHOT + 0.7.13 \ No newline at end of file diff --git a/convex-peer/pom.xml b/convex-peer/pom.xml index 6c5c92a35..696286b56 100644 --- a/convex-peer/pom.xml +++ b/convex-peer/pom.xml @@ -4,7 +4,7 @@ world.convex convex - 0.7.13-SNAPSHOT + 0.7.13 4.0.0 diff --git a/convex-restapi/pom.xml b/convex-restapi/pom.xml index 151729c34..3e1a9c76b 100644 --- a/convex-restapi/pom.xml +++ b/convex-restapi/pom.xml @@ -4,7 +4,7 @@ world.convex convex - 0.7.13-SNAPSHOT + 0.7.13 4.0.0 diff --git a/convex-sodium/pom.xml b/convex-sodium/pom.xml index 9453181b3..acc929c71 100644 --- a/convex-sodium/pom.xml +++ b/convex-sodium/pom.xml @@ -3,7 +3,7 @@ world.convex convex - 0.7.13-SNAPSHOT + 0.7.13 convex-sodium Sodium integration for Convex diff --git a/pom.xml b/pom.xml index 4d26df80d..54a858e80 100644 --- a/pom.xml +++ b/pom.xml @@ -2,7 +2,7 @@ 4.0.0 world.convex convex - 0.7.13-SNAPSHOT + 0.7.13 pom Convex Parent