doxygenでObjective-CソースからDoc生成

概要

    Objective-Cのソースに対して、JavaDoc形式コメントから

    HTMLなどでドキュメントを作成してくれるツール、

    doxygenについての導入メモ
    

    もちろんC++,Cにも使える。

    （というかObjective-C専用の設定は無かった。

        だがウマく出たので良しとする。）

    

目的

    Objective-Cプロジェクト中に、JavaDoc形式で書かれた文言から

    ドキュメンテーションを自動作成する。

    といっても、動作原理はJavaDocと変わらない。

    記法もJavaDocそのものなので、

    @paramとかの記述にも対応してくれる

インストール

    Mac向けのPackageで用意されているので、DLしてインストールする。

    Wizardに従う。

    doxygen

        http://www.stack.nl/~dimitri/doxygen/

使い方

    GUIがある。

    doxygenをインストールしたフォルダにappがあるので、起動。

    先ずは生成されるドキュメントのタイトルとかをセットする。

    Step1

    プロジェクトの置いてあるフォルダを指定。

    Step2については下記、

    Project name,versionは適宜。

    Source code directory 

        ソースが置いてある場所を指定。

        iPhone系であれば、classファイルのフォルダを指定するだけでOK。

        

    Specify the directory where doxygen should put ~

        doxygenがドキュメントを出力する場所について、指定する。

        Step1をこなせば、プロジェクトの置いてあるフォルダ近辺が自動入力される筈。

    次に、実行する。

    Runのタブを押し、Run doxygenボタンを押す。以上でドキュメント生成が完了する。

    Show HTML output　を押すと、完成したドキュメントが表示される。

    内容をもっとJavaDocらしくきちんと書けば、return,paramなども表示される。

    なかなか使えるんじゃなかろうか。

その他

    Graphviz というクラス関連図描画ソフトと連携しているらしいのだが、

    どうも出力時にエラーが出るようで、まだ正確に使っていない。

    Graphviz

        http://www.graphviz.org/