Doxygenで生成するドキュメントを多言語化するには

方法

• \~{言語 ID} に続けてコメントを書く.
• doxygen した時 Doxyfile の OUTPUT_LANGUAGE とマッチする 言語 ID の箇所のみコメントが抽出される.
• 言語 ID を指定せずに \~ {コメント} と書くと, OUTPUT_LANGUAGE の設定に依らず常に抽出されるコメントになる.

例

• 入力ファイル(ドキュメントの生成元)

foo.hpp

/*!
 * @brief \~english A class doing something awsome.
 *        \~japanese 何かすごいことするクラス.
 *
 * @details \~english Use Foo like this:
 *          \~japanese Foo はこのように使う:
 *          \~ <pre>Foo fooObject;
 * fooObject.doSomething();</pre>
 *          \~english Introduced since version 1.2.3.
 *          \~japanese バージョン 1.2.3 から導入された.
 */
class Foo
{
/* 略 */
};

• OUTPUT_LANGUAGE = Japanese とした Doxyfile を使うと, 例えば次のようなドキュメントになる.
  

• OUTPUT_LANGUAGE = English とした Doxyfile を使うと, 例えば次のようなドキュメントになる.
  

注意点

　Doxygen 1.8.8 以前のバージョンには, 言語 ID が Japanese-en のようにハイフン - を含んでいると \~ による言語切替が無視されるという問題がある.
　この問題は Doxygen 1.8.9 以降では修正されている.