ext-docでSencha Touchのドキュメントを作ってみる

ext-docとは

Ext JS/Sencha Touchのソースに特定の形式で書いてあるコメントから、
HTMLのドキュメントを作成するツールです。

ext-docのインストール

ext-doc - Project Hosting on Google Code
から最新版をダウンロードできます。
が、ここで公開されているLatest Buildは、Sencha Touchのソースに対しては動きません。。
ので、Subversionから最新版のソースを取得し、自力でビルドする必要があります。

といっても難しいことはなく、Javaの開発環境(1.6以上)と
Subversionクライアントがインストールされていれば、

1. svn checkout http://ext-doc.googlecode.com/svn/branches/1.0/ ext-doc-read-only
2. cd ext-doc-read-only
3. ant

で済みます。

build/dist/ext-doc-snapshot以下に、
ダウンロードできるLatest Buildと同じ形式で、
展開されます。

ext-docの実行

README.txtによると、以下の手順でできます。

Ext JS（Sencha Touch）のソースをダウンロード

Sencha - Sencha Touch - Downloads
からダウンロードします。

sample/extフォルダの作成

ソースからビルドした場合は、
build/dist/ext-doc-snapshot/sample/ext
フォルダを作成します。

Ext JS(Sencha Touch)のソースを"sample/ext"にコピー（例：sample/ext/source/core/Ext.js）

こんな感じ。

├─sample
│  └─ext
│      └─src
│          ├─core
│          ├─data
│          ├─gestures
...

sample/ext-doc.batの実行（outputフォルダが作成されます）

こんな感じ。

>java -jar ../ext-doc.jar -p ext.xml -o ../output -t ../template/ext/template.xml -verbose
Processing: ._Anim.js
Processing: ._Anim.more.js
Processing: ._CompositeElement.js
Processing: ._DomHelper.js
Processing: ._DomQuery.js
...

sampleフォルダと同じ並びに、outputフォルダが生成される。

outputフォルダをhttp serverへコピー

ていうか、オフラインで動くようにして欲しいんですが。。
しぶしぶWebサーバの公開フォルダへコピー。
で、表示してみた。

faviconが、、という感じですが、
無事できましたね。