search

LiskArchive / lisk-sdk

🔩 Lisk software development kit
https://lisk.com
Apache License 2.0
2.72k stars 457 forks source link

Add TypeDocs for the NFT module #9155

Closed Tschakki closed 6 months ago

Tschakki commented 7 months ago

What was the problem?

This PR ...

How was it tested?

npx typedoc open docs/typedoc/index.html

https://liskhq.github.io/lisk-docs/lisk-sdk/references/typedoc/modules/lisk_framework.html

codecov[bot] commented 7 months ago

Codecov Report

Attention: 18 lines in your changes are missing coverage. Please review.

Comparison is base (eff5d46) 84.70% compared to head (3e7b2bb) 84.66%. Report is 14 commits behind head on development.

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155/graphs/tree.svg?width=650&height=150&src=pr&token=2JhT7caf5x&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ)](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ) ```diff @@ Coverage Diff @@ ## development #9155 +/- ## =============================================== - Coverage 84.70% 84.66% -0.05% =============================================== Files 656 657 +1 Lines 24138 24071 -67 Branches 3500 3492 -8 =============================================== - Hits 20447 20379 -68 - Misses 3691 3692 +1 ``` | [Files](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ) | Coverage Δ | | |---|---|---| | [...nder/src/bootstrapping/commands/base\_ipc\_client.ts](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ#diff-Y29tbWFuZGVyL3NyYy9ib290c3RyYXBwaW5nL2NvbW1hbmRzL2Jhc2VfaXBjX2NsaWVudC50cw==) | `100.00% <ø> (ø)` | | | [...ommander/src/bootstrapping/commands/config/show.ts](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ#diff-Y29tbWFuZGVyL3NyYy9ib290c3RyYXBwaW5nL2NvbW1hbmRzL2NvbmZpZy9zaG93LnRz) | `96.15% <100.00%> (ø)` | | | [...src/bootstrapping/commands/genesis-block/create.ts](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ#diff-Y29tbWFuZGVyL3NyYy9ib290c3RyYXBwaW5nL2NvbW1hbmRzL2dlbmVzaXMtYmxvY2svY3JlYXRlLnRz) | `34.88% <ø> (ø)` | | | [commander/src/bootstrapping/commands/start.ts](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ#diff-Y29tbWFuZGVyL3NyYy9ib290c3RyYXBwaW5nL2NvbW1hbmRzL3N0YXJ0LnRz) | `85.91% <100.00%> (ø)` | | | [...r/src/bootstrapping/commands/transaction/create.ts](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ#diff-Y29tbWFuZGVyL3NyYy9ib290c3RyYXBwaW5nL2NvbW1hbmRzL3RyYW5zYWN0aW9uL2NyZWF0ZS50cw==) | `91.08% <100.00%> (+0.08%)` | :arrow_up: | | [...der/src/bootstrapping/commands/transaction/sign.ts](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ#diff-Y29tbWFuZGVyL3NyYy9ib290c3RyYXBwaW5nL2NvbW1hbmRzL3RyYW5zYWN0aW9uL3NpZ24udHM=) | `93.05% <ø> (ø)` | | | [commander/src/utils/genesis\_creation.ts](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ#diff-Y29tbWFuZGVyL3NyYy91dGlscy9nZW5lc2lzX2NyZWF0aW9uLnRz) | `69.23% <100.00%> (ø)` | | | [commander/src/utils/transaction.ts](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ#diff-Y29tbWFuZGVyL3NyYy91dGlscy90cmFuc2FjdGlvbi50cw==) | `98.18% <ø> (ø)` | | | [elements/lisk-transactions/src/validate.ts](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ#diff-ZWxlbWVudHMvbGlzay10cmFuc2FjdGlvbnMvc3JjL3ZhbGlkYXRlLnRz) | `100.00% <100.00%> (ø)` | | | [...n-connector-plugin/src/active\_validators\_update.ts](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ#diff-ZnJhbWV3b3JrLXBsdWdpbnMvbGlzay1mcmFtZXdvcmstY2hhaW4tY29ubmVjdG9yLXBsdWdpbi9zcmMvYWN0aXZlX3ZhbGlkYXRvcnNfdXBkYXRlLnRz) | `98.21% <100.00%> (ø)` | | | ... and [60 more](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ) | | ... and [1 file with indirect coverage changes](https://app.codecov.io/gh/LiskHQ/lisk-sdk/pull/9155/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=LiskHQ)