docs: finalizes documentation for xrpl.js (#1703)

docs: Adds JSDoc comments to all functions and interfaces
This commit is contained in:
Nathan Nichols
2021-10-12 12:04:18 -07:00
committed by GitHub
parent df4c9dc2fd
commit 615504db22
136 changed files with 3869 additions and 501 deletions

View File

@@ -47,6 +47,13 @@ module.exports = {
// no-shadow has false-positives for enum, @typescript-eslint version fixes that
'no-shadow': 'off',
'@typescript-eslint/no-shadow': ['error'],
'multiline-comment-style': ['error', 'starred-block'],
'jsdoc/check-examples': 'off',
// Allows the usage of @category -- TODO: try to add this in base config
'jsdoc/check-tag-names': 'off',
'tsdoc/syntax': 'off',
'jsdoc/require-description-complete-sentence': 'off',
},
overrides: [
{