JSDuckでJavaScriptのドキュメントを生成してみる

Backbone.jsのライブラリであるBackgrid.jsを調べていて、APIドキュメントを見てみると、右下に"Generated on Tue 07 May 2013 23:21:44 by JSDuck 4.8.0."とありました。
http://backgridjs.com/api/index.html

JSDuck
https://github.com/senchalabs/jsduck

というわけで、使い方のメモです。

1. インストール
gemでインストールするように書いてあります。

$ sudo gem install jsduck

2. Backgrid.jsのドキュメントを生成してみる
JSDuckを知る切っ掛けになったBackgrid.jsのドキュメントを、実際に作ってみます。

$ mkdir xxx #適当なディレクトリです。
$ cd xxx
$ mkdir docs #ここに生成してみます。
$ wget https://github.com/wyuenho/backgrid/archive/0.2.6.zip
$ unzip 0.2.6
$ jsduck backgrid-0.2.6/lib/ -o docs

なんかWarningが大量に出ましたが、docs/index.htmlにアクセスすると、それっぽいドキュメントが生成されていました。色々とオプションが有るようなので、確認せねば。