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/AVvXsEiB1kOD61BH0JVbRW4tPWcKGo9cn2qvAEKMKIv8GIk2ADjworshtJZz1TwvY4s9viflFD_Gc4dl7q39F7-ila22fGMDBladf-a4VIbyqJZFKuUmMkSPMiyvgyuPeKGpxvWEjjVaRAB3hb4/s1600/doxy01.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEiB1kOD61BH0JVbRW4tPWcKGo9cn2qvAEKMKIv8GIk2ADjworshtJZz1TwvY4s9viflFD_Gc4dl7q39F7-ila22fGMDBladf-a4VIbyqJZFKuUmMkSPMiyvgyuPeKGpxvWEjjVaRAB3hb4/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/AVvXsEgn4obMdF6qpLuVZJUEmRpFzRx7bVqKRNLOnX69iswmINIApI6cp7dV2nkw98QdNJCiXsWuMUYpVkpkTVP6XthSQdqdpVwqOXcCnXOiBCt-1UN5723nF6rQlzri9ctjdmZyDZjKyLLNGdE/s1600/doxy02.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEgn4obMdF6qpLuVZJUEmRpFzRx7bVqKRNLOnX69iswmINIApI6cp7dV2nkw98QdNJCiXsWuMUYpVkpkTVP6XthSQdqdpVwqOXcCnXOiBCt-1UN5723nF6rQlzri9ctjdmZyDZjKyLLNGdE/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/AVvXsEiWNZR_XcF-zw3q1-hRJJKrVgXAfIQJWcIsNGWJOmsPSq9mDOxRL4iqrj2EKCDmaE1fevtSSoBWsr7BMmCWlsO_dSQ_y8n-CrQ-aX78aHNC9DwSaeUe29F2G1jB9eiAn1R0y8NVVzx4kLM/s1600/doxy03.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEiWNZR_XcF-zw3q1-hRJJKrVgXAfIQJWcIsNGWJOmsPSq9mDOxRL4iqrj2EKCDmaE1fevtSSoBWsr7BMmCWlsO_dSQ_y8n-CrQ-aX78aHNC9DwSaeUe29F2G1jB9eiAn1R0y8NVVzx4kLM/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/AVvXsEhMWVDBHo3CJwakv7dW-oJjd2itN1JOEkt4UEozGdJRocm1aLiIobj-s4frnV9ke1k-hM-zRpBuhuHcqvmSVh5SoRB1aajdtHAirO1dwKZm2XnexZzkHOedb7Z5QNLeoQP3XgVZ8QDleMM/s1600/doxy04.png" imageanchor="1" ><img border="0" src="https://blogger.googleusercontent.com/img/b/R29vZ2xl/AVvXsEhMWVDBHo3CJwakv7dW-oJjd2itN1JOEkt4UEozGdJRocm1aLiIobj-s4frnV9ke1k-hM-zRpBuhuHcqvmSVh5SoRB1aajdtHAirO1dwKZm2XnexZzkHOedb7Z5QNLeoQP3XgVZ8QDleMM/s320/doxy04.png" width="320" height="264" data-original-width="732" data-original-height="604" /></a> ### 実行 Run タブから `Run doxygen` をクリックします。