2016/09/28

[作業記録] TOPPERS/ATK2 のソースコードを Doxygen と Graphviz を使って HTML ドキュメント化



目標

TOPPERS/ATK2 のソースコードを Doxygen と Graphviz を使って HTML ドキュメント化したい。
以下、TOPPERS/ATK2 というか、「AUTOSAR開発教材」の HTML ドキュメント化手順になってしまっているが、気にしないことにする。

やることリスト

  1. ソフト類ダウンロード・インストール
  2. TOPPERS/ATK2 関係のファイル取得
    1. AUTOSAR開発入門用プログラム
    2. TOPPERS/ATK2 カーネル簡易パッケージ
    3. TOPPERS/A-RTEGEN
    4. TOPPERS/A-COMSTACK
    5. TOPPERS/A-COMSTACK CAN ターゲット依存部
    6. AUTOSAR XML スキーマファイル
  3. 展開・配置
  4. ターゲット外のファイルを削除
  5. 自動生成ファイルを作る
  6. Doxygen でドキュメント作成

ソフト類ダウンロード・インストール

インストール手順は省略。それぞれインストールしてパスを通しておく。

ドキュメント生成に必要なソフト

TOPPERS/ATK2 に必要なソフト

TOPPERS/ATK2 関係のファイル取得

展開・配置

下記リンク先、「AUTOSAR開発入門用プログラム」の README の記述を参照し、ファイルを配置する。
README.txt in rc_autosar_rh850/trunk – Contributed Software : http://dev.toppers.jp/trac_user/contrib/browser/rc_autosar_rh850/trunk/README.txt#L108

ターゲット外のファイルを削除

  • a-comstack/canif/sample
  • a-comstack/com/sample
  • a-comstack/pdur/sample
  • a-rtegen/sample
  • atk2-sc1/sample
  • os-application
  • swc-application/1ecu
  • swc-application/2ecu_co_b
  • swc-application/2ecu_cod_b
  • swc-application/2ecu_od_cb

自動生成ファイルを作る

下記バッチファイルを実行し、ジェネレータにファイルを自動生成させる。
  • swc-application/3ecu/ecu_extract.bat
  • swc-application/3ecu/ecu_b/generator.bat
  • swc-application/3ecu/ecu_c/generator.bat
  • swc-application/3ecu/ecu_od/generator.bat
generator.bat 実行時に、cfg: error: cannot open file `cfg1_out.srec' といわれるが、今回は無視。CS+ インストールする元気がなかった...。

Doxygen でドキュメント作成

スタートから Doxywizard を起動する。
ウィザードにしたがって設定を入力する。






OUTPUT_LANGUAGE を「Japanese」に変更。

INPUT_FILTER を「nkf -w」に変更。
FILTER_SOURCE_FILES にチェックを入れる。
FILTER_SOURCE_PATTERNS に「*」を追加。

こんな感じのドキュメントが生成される。
...とはいえ、Doxygen が認識できる形式でコメントが書かれていないので、残念な感じは否めない。
以上。

0 件のコメント: