JSDoc3へのインストール

この解説は JSDoc3 を使用していることを前提としています。もし使っているのが`JSDoc Toolkit <https://code.google.com/p/jsdoc-toolkit/>`_ の場合は、自分でテンプレートをカスタマイズする必要があります。

githubのリポジトリに含まれているJSDoc3のテンプレートを参照してください。ここに完全なテンプレートの設定が保存されています。

JSDoc3を以下のようにインストールします (JSDoc3は現在 -g オプションをサポートしていません)。

$ git clone git@github.com:jsdoc3/jsdoc.git

次のようにJSDocを実行します:

$ node_modules/jsdoc/jsdoc -t templates/jsdoc3 [your javascript files]

出力ファイルが ./out フォルダに生成されます。次のコマンドを実行してインデックスを作成します:

$ bin/oktavia-mkindex -i out -r out -f "#main" -c 5 -o scripts -m html

ノート

Oktavia