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

Document source code using JSDoc #542

Closed
51 tasks done
karmacoma opened this issue Apr 10, 2017 · 1 comment
Closed
51 tasks done

Document source code using JSDoc #542

karmacoma opened this issue Apr 10, 2017 · 1 comment
Assignees
Milestone

Comments

@karmacoma
Copy link
Contributor

karmacoma commented Apr 10, 2017

Belongs to: #449

Instead of the originally planned use of YUIDoc in #413. We should document the lisk source code using: http://usejsdoc.org

New code can be documented immediately: http://usejsdoc.org/about-getting-started.html

Existing code we cover here, module by module. Below are the files I think we should focus on documenting.

logic

  • account.js
  • block.js
  • blockReward.js
  • broadcaster.js
  • dapp.js
  • delegate.js
  • inTransfer.js
  • multisignature.js
  • outTransfer.js
  • peer.js
  • peers.js
  • round.js
  • signature.js
  • transaction.js
  • transactionPool.js
  • transfer.js
  • vote.js

modules

  • accounts.js
  • blocks.js
  • crypto.js
  • dapps.js
  • delegates.js
  • loader.js
  • multisignatures.js
  • peers.js
  • rounds.js
  • server.js
  • signatures.js
  • sql.js
  • system.js
  • transactions.js
  • transport.js

helpers

  • RoundChanges.js
  • bignum.js
  • checkIpInList.js
  • config.js
  • database.js
  • diff.js
  • ed.js
  • exceptions.js
  • git.js
  • httpApi.js
  • inserts.js
  • orderBy.js
  • request-limiter.js
  • router.js
  • sandbox.js
  • sequence.js
  • slots.js
  • z_schema-express.js
  • z_schema.js
@karmacoma
Copy link
Contributor Author

Note: @4miners is currently documenting the blocks module as part of ongoing work in #449.

@karmacoma karmacoma added the hard label Apr 11, 2017
4miners added a commit that referenced this issue May 11, 2017
Initial documentation for blocks module - Closes #542
karmacoma added a commit that referenced this issue May 11, 2017
Initial JSDoc config and documentation - Closes #542
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants