javadoc только для package-info.java

Question

У меня есть ситуация, когда я хочу выполнить javadoc в проекте, который не имеет классов. У него есть только package-info.java для одного пакета. При выполнении Javadoc, даются следующее сообщение об ошибке:

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

Есть ли способ, чтобы заставить его обрабатывать package-info.java только (помимо очевидных Hacky решений: создание фиктивного класса, скриптовое копирование package.html и т. д.)?

Я выполняю javadoc как часть сборки maven, поэтому maven-javadoc-plugin выполняет действительную команду javadoc.

Answer 1

Невозможно запустить JavaDoc на пустой пакет. Существует действительно старый bug, размещенный для этой маркировки как «Закрыто, не будет исправлено».

В этой ошибке обходной путь в значительной степени является очевидным хакерским, о котором вы говорите, создайте пустой класс по умолчанию. Класс не будет включен в javadoc, если вы не заставите его быть с -package или -private.

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