Installing & Configuring JSDoc On Windows
This short tutorial will teach you how to install JSDoc on Windows.
DISCLAIMER: I have made every attempt to present accurate information, but I cannot guarantee that inaccuracies will not occur. I (the author) will not be held responsible for any claim, loss, damage or inconvenience caused as a result of any information found on this website (blog).
Lets do the installation and configuration step-by-step
- JSDoc is a perl script, so in order to execute JSDoc you have to install a perl interpreter. JSDoc documentation recommends ActivePerl for Windows users.
- Download the latest version of ActivePerl from http://www.activestate.com. Install ActivePerl on your windows machine.
- Download JSDoc from http://sourceforge.net/projects/jsdoc.
- Extract the downloaded zip file (above) in any folder.
- Now, in order to run JSDoc using ActivePerl you have to install HTML-Template package for ActivePerl.
- Assuming that you installed ActivePerl in c:\perl, go to c:\perl\bin and execute the command ‘ppm’.
- ppm is a package manager for ActivePerl. The command ‘ppm’ will open up a window showing you a list of all available packages. Give it sometime to download data from the Internet.
- Click on the button that reads “View All Packages” from the leftmost corner of the toolbar (or type Ctrl + 1 together).
- You’ll see a complete list of all packages. Scroll down to find HTML-Template. Once you find this package right click on it and click on install. This package will be marked for installation.
- Now, you have to install the package that you just marked. Click on the button that reads “Run marked actions” (green colored arrow pointing towards right) or type Ctrl + Enter together.
- You’re done. ActivePerl is setup properly to run JSDoc.
Documentation will be created inside the bin folder of ActivePerl in a folder named js_docs_out (JSDoc creates the output in js_docs_out folder in the folder where you run the jsdoc script from).