2009-07-16 3 views
8

クラスがないプロジェクトでjavadocを実行したいという状況があります。パッケージにはpackage-info.javaしかありません。 Javadocを実行すると、次のエラーが与えられます。javadoc for package-info.java

An error has occurred in JavaDocs report generation:Exit code: 1 - javadoc: error - No public or protected classes found to document. 

は(わき明らかハックソリューションからpackage-info.javaを処理するためにそれを強制する方法はあります:のコピーをスクリプト、ダミークラスを作成しますpackage.htmlなど)?

maven-javadoc-pluginが実際のjavadocコマンドを実行しているので、私はjavadocをmavenビルドの一部として実行しています。

+0

クラスがない場合、なぜパッケージjavadocが必要ですか? –

+0

私は、生成するより大きなサイトに対して "スプラッシュ"ドキュメントをカスタマイズする手段としてパッケージdocを使用するツール(特にenunciate)を使用しています。 – StevenC

+0

具体的には、何も含まれていないパッケージはなぜ存在するのですか? – harto

答えて

8

JavaDocを空のパッケージで実行する方法はありません。本当に古いbugが「Closed、Will Not Fix」とマークされています。

このバグでは、あなたが言及している明らかなハッキーですが、デフォルトスコープの空のクラスを作成してください。このクラスは、-packageまたは-privateを指定しない限り、javadocには含まれません。

/** hack to generate package javadoc */ 
class PlaceHolder {} 
+1

プレースホルダーのJavaクラスファイルには、少なくとも1つの/ ** * /コメントが必要です。そうしないと、問題を回避することができません。 – tgharold