Doxygenでドキュメント生成(5)

2013.2.27 新しい情報はこちら

(Doxygenでドキュメント生成(4) : Imai blog の続き)

Tips, その他

  • 日本語を扱う場合の重要な項目
    以下の項目さえ適切であればとりあえず何か出力されると思います。

    • DoxygenのConfigファイル
      • INPUT_ENCODING
        ソースコードのエンコーディングに合わせる。
      • LATEX_CMD_NAME
        platex -kanji=utf8 (Configファイルを直接編集時は、" "で括る。)
      • MAKEINDEX_CMD_NAME
        jmakeindex
      • USE_PDFLATEX
        チェックしない。
    • refman.texの編集
      usepackage{pspicture}をコメントアウト
    • Makefileの編集
      dvipsをdvipskに変更
  • Doxygenが作成するファイルの名前は、クラス名が含まれており何のファイルかがわかりやすい。しかしCDのファイル名長制限を越えるのでそのままCDに保存することはできない。HTMLをCD化しCDから直接参照できるようにしたいときは、SHORT_NAMESをチェックすると良い。
  • 日本語のドキュメントタイトル
    手っ取り早くするには、生成されたrefman.texを手で編集するのもよいと思う。
  • LaTeXのヘッダやスタイルシートを独自フォーマットにカスタマイズして利用することも可能。
  • HTMLのヘッダやフッタ、スタイルシートもカスタマイズできる。
  • コマンドラインで% doxygen -gを実行すると設定項目のコメント付きConfigファイル:Doxyfileが生成されるので参考にできる。

(とりあえず終了。何か気がついたらまた書きます)

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA