Doxygenとpackage.html

javadocの仕様に従って、関連パッケージのルートディレクトリにpackage-info.htmlというドキュメントファイルを配置しました。ただし、そのフォルダでDoxygenを実行すると、このファイルのドキュメントは取得されません。 Doxygenにこのファイルをパッケージドキュメントとして使用するように指示するにはどうすればよいですか？Doxygenとpackage.html

出典

2011-09-09 Nate Glenn

実際、現在のプラクティスは 'package-info.java'を' package.html'の代わりに使うことです。しかし、Doxygenについては考えがありません。 –

申し訳ありませんが、私はそれを変更し、doxygenはまだそれを正しくしません。私は自分の投稿を編集します。 –

これは確かに、 '.html'ではなく' package-info.java'であり、構文も異なります（http://download.oracle.com/javase/6/docs/technotes/tools /solaris/javadoc.html#packagecomment）。 –

Javaパッケージのドキュメントを提供する新しい代替方法は、の代わりにpackage-info.javaという名前のファイルを使用することです。これはまた、package前に指摘されているパッケージの注釈を（提供する唯一の方法である

/** 
* any javadoc comments (including tags) 
*/ 
package name;

：（。ファイル名が意図的に有効なクラス名ではないことが選択されている）

それは別の構文を持ちますここにキーワードがあれば）。

Doxygenの最近のバージョンでは、package-info.javaを理解しているに過ぎず、古いpackage.htmlファイルではありません。

モジュールシステムが提案されていますが、同様のmodule-info.javaファイルが追加されますが、私は短いgoogleingの後では見つかりません。（おそらくJSR 294？）

出典

2011-09-10 22:01:49

答えて

関連する問題