Skip to content

Commit

Permalink
Extra Javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
mikera committed May 8, 2024
1 parent 98d6425 commit 718e02d
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 11 deletions.
12 changes: 6 additions & 6 deletions convex-core/src/main/java/convex/core/crypto/BIP39.java
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ public static AKeyPair seedToKeyPair(Blob seed) {
* Note: longer term users may want hierarchical deterministic wallet generation
*
* @param seed BIP39 seed
* @return
* @return Ed25519 seed as a Blob
*/
public static Blob seedToEd25519Seed(Blob seed) {
long n=seed.count();
Expand Down Expand Up @@ -317,9 +317,9 @@ public static String createSecureMnemonic(int numWords) {

/**
* Create a list of random mnemonic words given a random number generator
* @param r
* @param n
* @return
* @param r Random number generator instance
* @param n Number of words to generate
* @return List of words
*/
public static List<String> createWords(SecureRandom r, int n) {
ArrayList<String> al=new ArrayList<>(n);
Expand Down Expand Up @@ -360,8 +360,8 @@ public static String normalise(String s) {

/**
* Create a mnemonic String from a list of words, separated by spaces
* @param words
* @return
* @param words List of words for mnemonic
* @return Combined mnemonic string
*/
public static String mnemonic(List<String> words) {
StringBuilder sb=new StringBuilder();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public void unlock(char[] password) {

/**
* Returns the data to be used for a wallet identicon. Should be the public account key
* @return
* @return Data to be used for an identicon
*/
public abstract AArrayBlob getIdenticonData();

Expand Down
4 changes: 2 additions & 2 deletions convex-core/src/main/java/convex/core/data/ABlobLike.java
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,8 @@ protected boolean appendHex(BlobBuilder bb, long length) {
/**
* Convert this BlobLike object to an ABlob instance, in the most efficient way.
*
* May return `this`. Result might not be a regular Blob (e.g. Address)
* @return
* May return `this`.
* @return Blob instance
*/
public abstract ABlob toBlob();

Expand Down
5 changes: 3 additions & 2 deletions convex-core/src/main/java/convex/core/data/prim/AInteger.java
Original file line number Diff line number Diff line change
Expand Up @@ -176,8 +176,9 @@ public static AInteger create(Number value) {
public abstract ABlob toBlob();

/**
* Return true if this value is a precisely equal to a valid 64-bit long integer
* @return
* Return true if this value is a valid 64-bit long integer
*
* @return true if this integer fits in a 64-bit long
*/
public abstract boolean isLong();

Expand Down

0 comments on commit 718e02d

Please sign in to comment.