Generating API Documentation

The API is fully documented using ESDoc syntax. You can read the docs in the source, or you can generate very readable and very nice-looking HTML documentation pages by running esdoc on the project.

To make the process easier, there is an npm script in the package.json file which you can use to generate the documentation. To do this, just follow along with this guide.

You need nodejs and npm installed on your machine.

Clone

Clone the repository to your local machine

git clone https://github.com/RichardMarks/Collision2D.git

Change directory into the cloned directory

cd Collision2D

Install

Install the node dependency tree for the project

npm install

Generate

Generate the documentation by running the script

npm run docs

After a few seconds or so, a new directory named docs will be created.

View

View the generated documentation by opening the index.html file.

open docs/index.html