Doxygen を使ってソースコードからドキュメントを作成する

C/C++ だとおそらくスタンダードな Doxygen について簡単にまとめてみました。 一応 C# なんかもいけますが、C# だと `DocFX` とかのほうがトレンドっぽいですね。 以下、Windows 版の前提です。 ## インストール 以下のサイトからダウンロードできます。 - http://www.stack.nl/~dimitri/doxygen/download.html インストールは普通に行えば OK です。 ## 設定方法 Doxygen は CUI が基本ですが、一応 GUI の設定ツールとして Doxywizard が付属しています。 ### Doxywizard での設定方法 Doxywizard で作成した設定はファイルとして保存できます。（デフォルトのファイル名は Doxygen） 「Step 1」の working directory に相対パスを指定した場合、次回 Doxygen ファイルを読み込んだときには絶対パスで表示されるようです。 まずは Project で以下を設定します。 - `Source code directory` で入力となるソースがあるフォルダを指定します。 - `Destination directory` で HTML や Latex の出力先のフォルダを指定します。 <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgaMVBn3Na0ONTVZmO9Ij87nVXHND_9y-8hbwzABd5UbT4D7MX98zrVVB4Bt75xh9zCkKJdHwkYarN9eY6iL21y6rBnvC_xq8Suu_fUMGCi_9n_TV-UsS6MKiONuORv_pa8cPFKXnq2Rk8/s1600/doxy01.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgaMVBn3Na0ONTVZmO9Ij87nVXHND_9y-8hbwzABd5UbT4D7MX98zrVVB4Bt75xh9zCkKJdHwkYarN9eY6iL21y6rBnvC_xq8Suu_fUMGCi_9n_TV-UsS6MKiONuORv_pa8cPFKXnq2Rk8/s320/doxy01.png" width="320" height="264" data-original-width="732" data-original-height="604" /></a> 言語を指定します。 <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEhsL9vinieyjK46dSlHzuI9Th_tHmX9dhkMS9V2sdr_Zq2yxbBHfrnBlK54fnkDklD1J9s5EQ2UDY-78P7mbFolAvju2OhNTaAqxx9pmNW5ZX50q4Ur4WavUNQdPHCzj0yAu-J5-3PaHR8/s1600/doxy02.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEhsL9vinieyjK46dSlHzuI9Th_tHmX9dhkMS9V2sdr_Zq2yxbBHfrnBlK54fnkDklD1J9s5EQ2UDY-78P7mbFolAvju2OhNTaAqxx9pmNW5ZX50q4Ur4WavUNQdPHCzj0yAu-J5-3PaHR8/s320/doxy02.png" width="320" height="264" data-original-width="732" data-original-height="604" /></a> 出力に関する設定を行います。 <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEh8-roOk4uLAxbXAp9bIVXBon2E0lNkvqixiK_bE1RkYaMaHcZESQ1_v8fomdZ_ijHOu6IxIc4sS79Hn_WzamzvAKRzyc4x4uAwmGP56PBRwQqM4K6cr_yF3siwxdMFKwbTiVhdKxOqhNI/s1600/doxy03.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEh8-roOk4uLAxbXAp9bIVXBon2E0lNkvqixiK_bE1RkYaMaHcZESQ1_v8fomdZ_ijHOu6IxIc4sS79Hn_WzamzvAKRzyc4x4uAwmGP56PBRwQqM4K6cr_yF3siwxdMFKwbTiVhdKxOqhNI/s320/doxy03.png" width="320" height="264" data-original-width="732" data-original-height="604" /></a> ダイアグラムに関する設定を行います。 Graphviz がインストールされていれば Graphviz を使用することでより詳細なダイアグラムを作成できます。 <a href="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEi8Wj5ZFfy1oEPAS8mZUlauUSgLrbiFCou94oFnxcZByCk-S9Fgl6w2EvTEJMSxrO8-Twj2m8TrqBpwaSnIDSiHt6qwyFMCVz8KbNzBLtxTdmKt0Um8X6ICqjExRWtBccbgkgCDNFE1mlQ/s1600/doxy04.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEi8Wj5ZFfy1oEPAS8mZUlauUSgLrbiFCou94oFnxcZByCk-S9Fgl6w2EvTEJMSxrO8-Twj2m8TrqBpwaSnIDSiHt6qwyFMCVz8KbNzBLtxTdmKt0Um8X6ICqjExRWtBccbgkgCDNFE1mlQ/s320/doxy04.png" width="320" height="264" data-original-width="732" data-original-height="604" /></a> ### 実行 Run タブから `Run doxygen` をクリックします。