ece496-blockchain-capstone-team / ece496-blockchain-simulator

Repository for the code for blockchain simulator capstone project
MIT License
2 stars 1 forks source link

TypeDoc for auto-generating documentation for classes #9

Closed dkhl65 closed 2 years ago

dkhl65 commented 2 years ago

Run yarn doc to generate HTML documentation under the docs folder. Open docs/index.html in a web browser. Everything under src/services is documented. Refer to https://typedoc.org/guides/doccomments/ for how to write comments in the classes. Try it out with comments like

/**
 * The content of the comment
 */

written before the class itself, a method or a property. In the future, make sure to have a comment for every class and all its methods and properties.

Closes #7