JS Lint? Check.
Unit tests? Check.
Documentation? Umm...

Don't worry -- documenting your JavaScript can be fun and easy! (Well, maybe just easy.)

This bundle provides tools for running and writing comments with JsDoc Toolkit directly from TextMate. JsDoc Toolkit is a great application for automatically generating documentation from commented JavaScript source code.

Installation

Installation: Recent TextMate (version 2)

cd ~/Downloads/
git clone git@github.com:rootworkit/JsDoc-Toolkit.tmbundle.git

Double-click the bundle in the Finder and click Install when the TextMate dialog pops up.

Installation : Older TextMate (version 1)

mkdir -p ~/Library/Application\ Support/TextMate/Bundles
cd ~/Library/Application\ Support/TextMate/Bundles
git clone git://github.com/csaccheri/JsDoc-Toolkit.tmbundle.git "JsDoc Toolkit.tmbundle"
osascript -e 'tell app "TextMate" to reload bundles'

Or use GetBundles (search for "JsDoc Toolkit").

Important! You must have Java installed to run JsDoc Toolkit.

Installation Troubleshooting

If the bundle fails to install, especially when upgrading from an older version, manually remove old versions of the bundle:

cd ~/Library/Application\ Support/Avian/Pristine\ Copy/Bundles/
rm -rf JsDoc-Toolkit*.tmbundle
cd ../../Bundles/
rm -rf JsDoc\ Toolkit.tmbundle/    

Usage

Snippets

This bundle includes a number of snippets to help you write JsDoc Toolkit-friendly comments. Use the docblock snippet (type doc then tab) to create a documentation comment block (starting with /**), then use the other snippets to generate the various tags JsDoc Toolkit supports.

Read the JsDoc Toolkit tag reference for a description of each tag and how it's used.

Commands

• Document with JsDoc Toolkit (⌃⌘J) Generates HTML documentation from commented JavaScript source code using JsDoc Toolkit 2.4.0 and displays it in TextMate's Web Preview window. You can generate documentation from a single file, multiple selected files, or an entire directory.
  You can find the generated documentation in
  ~/Library/Application Support/TextMate/Bundles/JsDoc Toolkit.tmbundle/Support/bin/jsdoc-tookit/out

• Edit JsDoc Toolkit Configuration (⌃⌘J) Opens the configuration file used by the bundle to run JsDoc Toolkit. You can edit this file to change configuration options, such as whether to show private methods, use a different output template, etc. See JsDoc Toolkit command line options for more information.

• View Tag Reference (⌃⌘J) Opens the JsDoc Toolkit tag reference in TextMate's Web Preview window.

License

• JsDoc Toolkit (MIT License)