2009-05-23
Erica女史みたいにDocumentを作る方法
Erica Sadun, Doxygen | |
Erica女史が公開しているTimberline Documentationは、ある程度ググったりしているうちに存在を認識する人も多いドキュメントです。undocumentedなメソッドを一覧化していたりして、hackの第一歩には色々と有り難い代物です。
そのうち、「あんな感じで自分のプロジェクトでもつくれたらなー」とか思ったりしてくるわけですが、下準備が面倒なだけであって作れないわけではありません。
Timberline DocumentationはDoxygenを用いています。Doxygenを実行することで得られるメリットが非常に大きいため、プロジェクトの文書化を考えている人にはかなりおすすめです。
インストール
Doxygenは幾つかのライブラリが必要になります。各々のライブラリは公式サイトからバイナリとソースコードの両方で配布されているケースが多いのですが、MacPortsからでもカバー可能です。
MacPortsからのインストールがお手軽だったため、このエントリではMacPortsを用いています。
graphvizのインストール
macportsにてgraphvizをsearchすると、結構な数が引っかかります。
%sudo port
password:
>search graphviz
graphvizそのものもあるんですが、
Format: "png" not recognized. Use one of: dia hpgl mif mp pcl pic vtx
とエラーが出力されます。これはpng形式等のサポートの問題で、graphviz-gdのほうが必要です(参考:graphvizで Format: "png" not recognized. - あぁ そうだった)。
>install graphviz-gui-devel
webdotのインストール
>install webdot
doxygenのインストール
>install doxygen
Doxygenの設定
ドキュメントを出力したい対象プロジェクトのClassesディレクトリに移動して、コマンドを実行します。最初行うのは設定ファイルの作成です。
(参考:Doxygenをつかおう)
%doxygen -g
これによって出力されるdoxyFileをそのまま使おうとすると、グラフが出力されなかったり、
Error: /rangecheck in /findfont
Operand stack:
--nostringval-- 10 FreeSans
とエラーが発生するため、編集します。
(参考:DOT_FONTNAME (Doxygen 1.5.6) - 無為空間, DOT_FONTNAME ni Hiragino - 無為空間)
OUTPUT_DIRECTORY = ../Doxygen
EXTRACT_ALL = YES
HAVE_DOT = YES
DOT_FONTNAME = "\"Hiragino Kaku Gothic Pro\""
Doxygenの実行
%doxygen doxyFile
Classes内で上記コマンドを実行します。プロジェクトのrootにDoxygenというディレクトリが出力されます。この中のhtml/index.htmlを開きます。