Generic documentation script

Past entries

For the past few weeks, I have been working on a new HTML5 project, which requires a lot of Javascript (more than eight thousand lines so far), and I've come to the conclusion that I really needed to create documentation to be able to quickly find functions prototypes and other usual stuff.

Unfortunately, I haven't been able to find a convenient existing solution for Javascript projects. Other languages such as Java (with Javadoc) have a specific way to generate HTML documentation, which is very useful for big projects, so I decided to make something similar, using Perl.

The script is a lot more basic than other solutions, but it might be useful for others who have the same problem. It is based on annotations and is designed for class-based only projects (similar to Java).

You can download the script here, and you can check an example documentation at http://doc.remvst.com/example. Instructions can also be found there on the home page.

All you need is a system that can run Perl scripts (no installation required).

Documentation example Example of generated documentation
< Haunted Gardens - level editor
Setters/getters for Internet Explorer 9 >