Skip to content

Commit

Permalink
Change method visibility (#215)
Browse files Browse the repository at this point in the history
* Change all @Private to @ignore

* Fix jsdoc typo

* Add @ignore to private methods

* Fix gaurd typo

* ignore #perform method

* Revert "ignore #perform method"

This reverts commit e62634e.

* Remove default statements + ignore #perform

* Ignore _setTimeout

* Fix tag spacing + default duplication
  • Loading branch information
Juuddi authored Jun 25, 2024
1 parent e2e3c76 commit 3a68b4b
Show file tree
Hide file tree
Showing 31 changed files with 574 additions and 362 deletions.
2 changes: 1 addition & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"plugins": ["prettier-plugin-jsdoc"],

"jsdocCommentLineStrategy": "multiline",
"jsdocSeparateReturnsFromParam": true,
"jsdocSeparateReturnsFromParam": false,
"jsdocPreferCodeFences": true,
"tsdoc": true,
"jsdocPrintWidth": 120
Expand Down
8 changes: 2 additions & 6 deletions src/abi/abi-coder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,6 @@ export class AbiCoder {
* `false`.
*
* @param {(string | ParamType)[]} types - Array of parameter types to get default values for.
*
* @returns {Result} The default values corresponding to the given types.
*/
getDefaultValue(types: ReadonlyArray<string | ParamType>): Result {
Expand All @@ -197,7 +196,6 @@ export class AbiCoder {
*
* @param {(string | ParamType)[]} types - Array of parameter types.
* @param {any[]} values - Array of values to encode.
*
* @returns {string} The encoded data in hexadecimal format.
*/
encode(types: ReadonlyArray<string | ParamType>, values: ReadonlyArray<any>): string {
Expand All @@ -219,9 +217,7 @@ export class AbiCoder {
*
* @param {(string | ParamType)[]} types - Array of parameter types.
* @param {BytesLike} data - The ABI data to decode.
* @param {boolean} [loose=false] - Enable loose decoding. Default is `false` Default is `false` Default is `false`
* Default is `false`
*
* @param {boolean} [loose=false] - Enable loose decoding. Default is `false`
* @returns {Result} The decoded values.
*/
decode(types: ReadonlyArray<string | ParamType>, data: BytesLike, loose?: boolean): Result {
Expand All @@ -233,6 +229,7 @@ export class AbiCoder {
/**
* Set the default maximum inflation factor.
*
* @ignore
* @param {number} value - The new inflation factor.
*/
static _setDefaultMaxInflation(value: number): void {
Expand Down Expand Up @@ -265,7 +262,6 @@ export class AbiCoder {
* @param {CallExceptionAction} action - The action that triggered the exception.
* @param {Object} tx - The transaction information.
* @param {BytesLike | null} data - The data associated with the call exception.
*
* @returns {CallExceptionError} The corresponding call exception error.
*/
static getBuiltinCallException(
Expand Down
Loading

0 comments on commit 3a68b4b

Please sign in to comment.