Multi-language Document

XOOPS Cube には英語の Doxygen ドキュメントが用意されています。

minahito_sandbox ブランチでは、このドキュメントの多言語対応の実験を行っています。といっても、当然翻訳ドキュメントを準備しなければなりませんが……

仕組みとしては非常に単純です。(-_-;
元々 Doxygen は、ソースコードとドキュメントコメントを別々の場所に書くことができます。具体的には、以下のようなコメントを持つファイルをプログラムと別の場所に持つことができます。

/**
 * @class XCube_Root
 * @brief ....
 *
 * @function getRenderSystem
 * @brief ...
 * @param ...
 */

ただし、これだけでは関数のシグニチャなどが分かりませんから、その情報はソースコードから取ってきます。普通 Doxygen ではドキュメントコメントはソースコード内に埋め込みます。

今回の多言語対応ではこの仕組みを利用して、ソースコードに埋め込んだ英語を取り除きながら、日本語のコメントのみのファイルを読み込んで Doxygen にドキュメントを生成させています。お手元では make 一発で生成できるようにしてあります。

make doxygen
make doxygen_ja

英語以外のドキュメントを生成するには bash 環境が必要です。 Win な方は cygwin を使ってください。僕の方は Mac OS X で確認しています。Doxygen をパスに通すことをお忘れなく！