README.mdをDoxygenのmainpageにする

GitHubプロジェクトのドキュメントをDoxygenで生成していると、「mainpageを書くのが面倒だなぁ」と思うことがあります。

Doxygen文書のmainpageはAPIやプロジェクトの概要を書く部分ですが、まさにそれと同じものをREADME.mdに書くため2重の労力がバカバカしく感じます。また、コピペするにも推敲や変更のたびに行うのは面倒ですし間違いのもとです。

よくしたものでDoxygenにはREADME.mdをmainpageにするというドンピシャの機能があります。

設定

設定は簡単です。Doxyfile（Doxygenの設定ファイル）で、INPUTとUSE_MDFILE_AS_MAINPAGEを以下のように設定します。

INPUT                  = src README.md
USE_MDFILE_AS_MAINPAGE = README.md

USE_MDFILE_AS_MAINPAGEでREADME.mdを指定しても、INPUT対象にREADME.mdが入っていないときちんと動作しません。注意してください。