Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Add TypeDoc to lisk-transactions #7909

Merged
merged 23 commits into from
Jan 9, 2023
Merged

Conversation

Tschakki
Copy link
Contributor

@Tschakki Tschakki commented Dec 19, 2022

What was the problem?

This PR resolves #7901

Please note there is currently a bug in TypeDoc with the effect that references between packages are not working, see TypeStrong/typedoc#1835

How was it solved?

  • Export relevant data structures
  • Add relevant code comments
  • Add typedoc to the dev dependencies
  • Add typedoc options to the package.json in each package.
  • Create typedoc.json and include required options for generating the docs properly.
  • Create new folder docs/typedoc to store generated typeDocs

How was it tested?

cd lisk-sdk/
npx typedoc

Result

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

@Tschakki Tschakki self-assigned this Dec 19, 2022
@Tschakki Tschakki marked this pull request as ready for review December 20, 2022 17:30
@Tschakki Tschakki requested a review from ishantiw December 20, 2022 17:31
@sitetester sitetester self-requested a review December 27, 2022 12:05
elements/lisk-transactions/src/fee.ts Outdated Show resolved Hide resolved
elements/lisk-transactions/src/schema.ts Outdated Show resolved Hide resolved
elements/lisk-transactions/src/validate.ts Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Dec 27, 2022

Codecov Report

Merging #7909 (dc1d627) into development (3214cf7) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##           development    #7909   +/-   ##
============================================
  Coverage        82.25%   82.25%           
============================================
  Files              578      578           
  Lines            20908    20913    +5     
  Branches          3037     3037           
============================================
+ Hits             17198    17203    +5     
  Misses            3710     3710           
Impacted Files Coverage Δ
elements/lisk-transactions/src/constants.ts 100.00% <ø> (ø)
elements/lisk-transactions/src/format.ts 100.00% <ø> (ø)
elements/lisk-transactions/src/schema.ts 100.00% <ø> (ø)
elements/lisk-transactions/src/sign.ts 92.30% <ø> (ø)
elements/lisk-transactions/src/validate.ts 91.66% <ø> (ø)
elements/lisk-transactions/src/fee.ts 100.00% <100.00%> (ø)
elements/lisk-transactions/src/index.ts 100.00% <100.00%> (ø)

@shuse2 shuse2 removed the type: docs label Dec 28, 2022
commander/README.md Show resolved Hide resolved
docs/typedoc/.nojekyll Outdated Show resolved Hide resolved
@shuse2 shuse2 removed the request for review from ishantiw January 5, 2023 20:46
@Tschakki Tschakki requested a review from shuse2 January 9, 2023 14:47
commander/README.md Show resolved Hide resolved
@shuse2 shuse2 enabled auto-merge (squash) January 9, 2023 16:04
@shuse2 shuse2 merged commit fa63da6 into development Jan 9, 2023
@shuse2 shuse2 deleted the 7901-lisk-transactions-typedoc branch January 9, 2023 16:12
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create example how to document code with TypeDoc
3 participants