mirror of
https://github.com/cse110-fa22-group29/cse110-fa22-group29.git
synced 2024-12-28 01:39:09 +00:00
19 lines
444 B
Markdown
19 lines
444 B
Markdown
# 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.
|