Skip to content
This repository was archived by the owner on Aug 30, 2022. It is now read-only.

Commit c4f4bcf

Browse files
author
anguyen
committed
Added package and model's classes javadoc
1 parent 2518ded commit c4f4bcf

45 files changed

Lines changed: 592 additions & 561 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎eosiojava/src/main/java/one/block/eosiojava/enums/package-info.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/*
2+
* Copyright (c) 2017-2019 block.one all rights reserved.
3+
*/
4+
5+
/**
6+
* Provides the enums necessary for using in eosio-java core.
7+
*/
8+
9+
package one.block.eosiojava.enums;

‎eosiojava/src/main/java/one/block/eosiojava/error/EosioError.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ public EosioError(@NotNull Exception exception) {
4646
}
4747

4848
/**
49-
* @return A JSON formatted string describing the error code, and reason.
49+
* Construct a JSON formatted string describing the error code, and reason.
50+
*
51+
* @return A JSON formatted string
5052
*/
5153
@NotNull
5254
public String asJsonString() {

‎eosiojava/src/main/java/one/block/eosiojava/error/abiProvider/package-info.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/**
2+
* Provides the classes necessary for describe meaningful exceptions that occur during an ABI Provider implementation like:
3+
* {@link one.block.eosiojava.error.abiProvider.GetAbiError}
4+
*/
5+
6+
package one.block.eosiojava.error.abiProvider;

‎eosiojava/src/main/java/one/block/eosiojava/error/package-info.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/**
2+
* Provides the classes/constants necessary for describe meaningful exceptions that occur on all process of eosio-java like:
3+
* {@link one.block.eosiojava.session.TransactionProcessor} flow,
4+
* {@link one.block.eosiojava.utilities.EOSFormatter} utilities and other processes.
5+
*/
6+
7+
package one.block.eosiojava.error;

‎eosiojava/src/main/java/one/block/eosiojava/error/rpcProvider/package-info.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/**
2+
* Provides the classes necessary for describe meaningful exceptions that occur during an PRC Provider implementation like:
3+
* {@link one.block.eosiojava.error.rpcProvider.GetInfoRpcError}
4+
*/
5+
6+
package one.block.eosiojava.error.rpcProvider;

‎eosiojava/src/main/java/one/block/eosiojava/error/serializationprovider/package-info.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/**
2+
* Provides the classes necessary for describe meaningful exceptions that occur during an Serialization Provider implementation like:
3+
* {@link one.block.eosiojava.error.serializationprovider.SerializeTransactionError}
4+
*/
5+
6+
package one.block.eosiojava.error.serializationprovider;

‎eosiojava/src/main/java/one/block/eosiojava/error/session/package-info.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/**
2+
* Provides the classes necessary for describe meaningful exceptions that occur during {@link
3+
* one.block.eosiojava.session.TransactionProcessor} and {@link one.block.eosiojava.session.TransactionSession}
4+
* implementation like: {@link one.block.eosiojava.error.session.TransactionGetSignatureError}
5+
*/
6+
7+
package one.block.eosiojava.error.session;

‎eosiojava/src/main/java/one/block/eosiojava/error/signatureProvider/package-info.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/**
2+
* Provides the classes necessary to describe meaningful exceptions that occur during a signature
3+
* provider implementation like {@link one.block.eosiojava.error.signatureProvider.SignTransactionError}
4+
*/
5+
6+
package one.block.eosiojava.error.signatureProvider;

‎eosiojava/src/main/java/one/block/eosiojava/error/utilities/EosFormatterSignatureIsNotCanonicalError.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* Error class is used when there is an exception while attempting to convert DER/Raw R and S signature to EOS format signature but the signature is not canonical.
1111
* <br>
1212
* * This exception only and randomly happen with signature signed with SECP256K1 curve key
13+
* <br>
1314
* * The flow need to resign the signature to pass this exception.
1415
*/
1516
public class EosFormatterSignatureIsNotCanonicalError extends EOSFormatterError{

‎eosiojava/src/main/java/one/block/eosiojava/error/utilities/package-info.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
/**
2+
* Provides the classes necessary to describe meaningful exceptions that occur during process of
3+
* eosio-java utilities. like {@link one.block.eosiojava.error.utilities.PEMProcessorError}
4+
*/
5+
6+
package one.block.eosiojava.error.utilities;

0 commit comments

Comments
 (0)