Change JSDoc to TSDoc
ebebbington opened this issue · 0 comments
ebebbington commented
Summary
What: Convert JSDoc blocks (though we use a mix of JSDoc and Deno's standard), to TSDoc blocks in Typescript files
Why: We primarily use TypeScript so it makes sense to use TSDoc. Types are already documented in the method/property anyways.
Acceptance Criteria
- All doc blocks converts to TSDoc
Example Pseudo Code (for implementation)
* @param string filename
* The filename to do something with
* @param filename - The filename to do something with
Resources
TSDoc is very similar, there is really only a few minor changes to make to each doc block