はじめに
先日、cocos2d-x 3.0のalpha版がリリースされました。
2.xまでとAPIが大きく変更されており、今までと同じことをするのにもドキュメントが必須。
しかし、ドキュメントはオンライン上でHTMLでしか提供されておらず、非常に読みにくいです。
というわけで、cocos2d-x 3.0のドキュメントをDashで読む方法をまとめました
Dashの導入
DashはMac向けのドキュメントビュワー。高い検索性と動作の軽快さが素晴らしい。まだ導入していない方はこの機会に是非
Dash - Documentation Browser, Snippet Manager - Kapeli
cocos2d-x 3.0 alphaのダウンロード
こちらからダウンロード
Download Cocos2d-x Cocos2d-html5 CocoStudio | Cocos2d-x
Doxygenの導入
cocos2d-xのドキュメントはDoxygenで生成されており、既に設定ファイルが用意されています。今回はHomebrewで導入
brew install doxygen
設定ファイルの変更
先ほどダウンロードしたcocos2d-x 3.0を解凍し、doc
ディレクトリ下にある設定ファイルを編集します
cd path/to/cocos2d-3.0/doc/
vim doxygen.config
実はDoxygenではDocsetsを自動生成してくれる機能があるのですが、デフォルトでは無効になっているので、下記のページを参考に設定ファイルを書き換える。
Generating Dash Docsets - Kapeli
GENERATE_DOCSET = YES # must
DISABLE_INDEX = YES # (Optional)
SEARCHENGINE = NO # (Optional)
GENERATE_TREEVIEW = NO # (Optional)
また、生成されるドキュメントのメタデータが古いバージョンのままなので、下記を変更してあげる
PROJECT_NUMBER = 3.0
ドキュメントの生成
doxygen doxygen.config
これを行うと、doc下にhtml
というディレクトリが生成されますが、まだ肝心なDocsetは生成されていません。
そこで、html
化でmakeをしてやる
cd html
make
これでドキュメントの生成が開始されます。かなり時間がかかるので注意。(20分程度)
Dashに読み込む
生成されたドキュメントはdoc/html/org.doxygen.Project.docset
なので、適当な場所に移動してあげる
mv org.doxygen.Project.docset ~/Library/Developer/Shared/Documentation/DocSets/org.cocos2d-3.0.docset
その後、Dashのメニューバー、Dash > Preferences > Docsets
左下の追加ボタンから、今保存したDocsetを指定してあげると良いでしょう
見れた!!!