jsdoc notation plus jsdoc npm to generate documentation

cambsull / SteamWebAPILibrary

A JavaScript Library to make calls to the Steam Web API easier

https://cambsull.github.io/SteamWebAPILibrary/

MIT License

4 stars 2 forks source link

jsdoc notation plus jsdoc npm to generate documentation #45

Closed mdwiltfong closed 4 months ago

mdwiltfong commented 4 months ago

This PR address issue #11

It adds JSDOCs to the library. It also brings in the jsdoc npm package. If you run jsdoc ./src/SteamWebAPILibrary.js (after installing the npm package) it will create an directory with HTML files which can be used with GitHub Pages to generate documentation.