Javaドキュメンテーションコメント多言語フィルタ。

Ver. 0.0.0 2011-04-xx tsurutsuru <kiramik@users.sourceforge.jp>

divタグで記述言語を指定したドキュメンテーションコメントに対し、 javadoc作成時のコマンドラインパラメータにより出力言語を指定するフィルタdoclet。 例えば以下の様なドキュメントに対し

                <div lang="ja">
                これは日本語のコメントです。
                </div>
                <div lang="en">
                This is English comment.
                </div>
            

コマンドラインから次のようにパラメータを与えると 生成されるjavadocは

                This is English comment.
                これは日本語のコメントです。
            

のように生成される。

このdocletの目的としては、単一ソースファイルにすべてのドキュメントを集約することにあります。 小規模なプロジェクトでは、ソースファイルの外に訳語を置いても翻訳するのは結局プログラマなので、 メンテナンスがかえって煩雑になる場合などに対応することを念頭においています。

しかし良く考えれば、 ドキュメンテーションコメント内にタグを埋め込むならdocletを使わなくても、 CSSでタグブロックごとに可視/不可視属性を設定してやるjavaScriptを javaドキュメントに埋め込むというアプローチのほうがよかったかもしれない。 ページ上部に言語選択のドロップダウンリストボックスなどをつけてやれば、 言語別にドキュメントの生成を行う必要がない。

このdocletの制限事項は次の通り。

• divとspanを区別しておらず、言語タグがネストすると上手く取り扱えない。
• ソートできるのは隣り合う言語ブロック同士だけである。
• divは前後に改行が入り、spanは改行が入らない、という使い分けをすること。
• 言語ブロックの間のHTMLソース上の空白はその直前の言語ブロックに属する。
• package-info.javaのドキュメンテーションコメントが今のところ(Ver0)処理できない。
• デフォルト言語が指定できない。つまり、コマンドラインで与えた言語ブロックがないとき、代替で表示する言語ブロックを指定する、と言うことが出来ない。

本docletのライセンスはGPL V3に従うものとし、 あなたがこのdocletを改変したばあいは、 GPL V3または任意により新しい後続のバージョンのライセンスに従うものとして扱ってください。 <http://www.gnu.org/licenses/>

Java documentation comment multilingual filter doclet.

This doclet extract and sort language block which in java documentation comment using <div lang="xx">...</div> tag block.

Example; java documentation comment are:

                <div lang="ja">
                これは日本語のコメントです。
                </div>
                <div lang="en">
                This is English comment.
                </div>
            

doclet command line parameter are:

javadoc ... -doclet MultilingualFilter - docletpath C:\...\MultilingualFilter.jar -sellang en,ja
            

then, output document will be:

                This is English comment.
                これは日本語のコメントです。