alu/cse110-fa22-group29
1
0
Fork 0
mirror of https://github.com/cse110-fa22-group29/cse110-fa22-group29.git synced 2024-11-10 05:34:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
603fb849f3
cse110-fa22-group29/specs/adrs/112922-doccumentation-jsdoc.md
Arthur Lu 603fb849f3 add explanation of JSDoc usage to ADR
2022-11-29 22:23:24 +00:00

447 B
Raw Blame History

Use JSDoc for JS documentation

  • Status: accept
  • Deciders: Arthur Lu, Marc Reta
  • Date: 11 / 29 / 22

Decision Drivers

  • Need simple way to publish documentation for code
  • Already documentating infile using JSDoc style

Considered Options

  • JSDoc

Decision Outcome

Chosen Option: JSDoc. Will run by generating docs in /source/docs/ before publishing /source/ so users can enter the URI /docs/ to see documentation.