jGrouseDoc Overview

jGrouseDoc has the following features:

• Documentation is produced from javadoc-style comments that are already familiar to many developers
• Allows documenting of Javascript classes, regardless which approach or framework is being used for it - be it Prototype, Dojo, Dean Edward's Base, jGrouse or any other.
• Allows documenting multiple interfaces for the same function. In Java you can declare several functions with different parameter set, but it is not the case in Javascript - instead developers need to put certain logic into the function to distinguish between alternate calls.
• Allows documenting Javascript namespaces. Nothing new, for example Natural Docs also has such feature, but jGrouseDoc provides developers with higher flexibility when documenting objects in those namespaces
• Allows documenting of artefacts that are not directly supported by Javascript, for example interfaces
• The output is highly customizable. The rendering is based on XSL Transformation, so users can simply modify appropriate XSL template.
• The tool is implemented as Ant task, so it could be easily integrated with existing build environment. If there would be a demand, then later it would be possible to build a standalone tool and Maven plugin.

For the details see the documentation for jGrouseDoc and also examples included with the distribution.

jGrouseDoc is an open source project distributed under modified BSD license from Google Code. Your comments and suggestions are very welcome, please send me a note to denis@jgrouse.com.