Software/Doxygen

Doxygen に関する情報 †

Doxygenの説明 †

• Doxygen は C/C++ のソースコードの解析とコメントの抽出を行い、ドキュメントの自動生成を行うことが出来ます。
• Doxbar は、Doxygen を VC++ 上で利用できるようにするプラグインソフトです。

ダウンロード †

• Doxygen
  • http://www.doxygen.org/
• Doxbar
  • http://doxbar.sourceforge.net/
• Microsoft HTML Help Downloads
  • http://msdn.microsoft.com/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp

Doxygen & Doxbar のセットアップ方法 †

• Doxygen のセットアップ方法
• Doxbar のセットアップ方法

  1. Doxbar の最新版をダウンロードする
     http://doxbar.sourceforge.net/
     例）
     doxbar-*.**-bin.zip
  2. Doxbar を解凍する
  3. VC++ を起動する
  4. [ツール] - [カスタマイズ] を選択する
  5. [アドオンおよびマクロ ファイル] タブを選択する
  6. [参照] ボタンをクリックし [doxbar.dll] を選択する。
     [Doxbar.DSAddIn.1] がチェックされていることを確認しダイアログを閉じる。
  7. 再度 [ツール] - [カスタマイズ] を選択する。
  8. [ツール] タブを選択し [Doxygen] というメニューを追加する。
     メニュー項目:[Doxygen]
     コマンド    :[c:\windows\temp\runbox.bat]
                （このファイルは自動生成されるため、用意しておく必要は無い。）
     引数        :[]
     実行時のディレクトリ:[$(WkspDir)]
     [*]アウトプットウィンドウを使用 [ ]起動時に引数を入力
  9. Doxbar ツールバーの [Configure Doxbar] を選択する。
     [User tool] タブ
     tool command:[UserTool8]（登録してある番号を入力）
     [File locations] タブ
     Batch file:[c:\windows\temp\runbox.bat]
     Doxygen   :[C:\Program Files\doxygen\bin\doxygen.exe]
     Configuration template
               :[C:\Program Files\doxygen\bin\Doxyfile]
     （doxygen -g で雛形の設定ファイルが作成されるのでそれを利用。）
     HTML Help compiler
               :["C:\Program Files\HTML Help Workshop\hhc.exe"]
  10. Doxbar ツールバーの [Edit project's profile] を選択する。
     [Doxbar specific]
     Generate documentation for (*) the active project only
                                ( ) the active project and its dependencies
                                ( ) all the projects in the workspace
     （デフォルトはアクティブプロジェクト＆依存関係のあるプロジェクトに設定）

Doxbar でコンパイルするときの注意点 †

• ファイル名の大文字と小文字を区別する？

  どうやら #include しているファイル名と *.dsp に設定してあるファイル名に
  大文字・小文字の相違がある場合、*.rtf ファイルの作成に失敗する模様。
  例）プロジェクトファイル（*.dsp）に登録してある名称
  Resource.h … ×
  resource.h … ○
  ＜エラーメッセージ＞
  Error opening rtf file resource_8h.rtf for reading
  An error occurred during post-processing the RTF files!

rtfファイルを doc形式（Word形式）に変換するときの注意点 †

• 単純に rtf → doc 形式で保存しただけでは画像データ（クラス継承図）が埋め込まれない。
• 以下の方法で埋め込むことが可能。

  [Ctrl]+[A], [F9] で、フィールド情報更新
  [Ctrl]+[Shift]+[F9] で、埋め込みオブジェクトを図に変換

  • しかし、この方法だとリンク情報までが消えてしまう。

• 画像データのみ埋め込む方法

  Sub UnlinkPicture() 
      ' 対象データが無くなるまでループ
      Do 
          Set oldRange = Selection.Range 
          Set newRange = Selection.GoTo( What:=wdGoToField, _
              Which:=wdGoToNext, Count:=1, Name:="INCLUDEPICTURE") 
          If oldRange.Start = newRange.Start Then 
              Exit Do 
          End If 
          ' 対象データを選択
          Selection.MoveRight Unit:=wdWord, Count:=1, Extend:=wdExtend 
          ' リンクの実体化
          Selection.Fields.Unlink
          ' 選択を解除
          Selection.MoveRight Unit:=wdCharacter, Count:=1 
      Loop 
  End Sub 

ML †

• FreeML ML情報ページ [doxygen-users]
  • http://www.freeml.com/ctrl/html/MLInfoForm/doxygen@freeml.com

関連リンク †

• Doxygen マニュアル（日本語訳）
  • http://www.fides.dti.ne.jp/~oka-t/doxygen-manual/html/
• Doxygen を使おう
  • http://www.fides.dti.ne.jp/%7Eoka-t/doxygen.html
• テキストエディタ非公式版 - コメントの書き方(クラス・関数のコメント)
  • http://members.at.infoseek.co.jp/sakura_editor/comment-rule.html
• doxygenをつかってみよう
  • http://www.doumo.jp/aon-java/jsp/postgretips/tips.jsp?tips=36
• RADKRAFT: Doxygen
  • http://kamakura.cool.ne.jp/oppama/misc/doxygen.html