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 (кроме очевидных хакерских решений: создание фиктивного класса, создание сценариев копирования package.html и т. Д.)?

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

Answer 1

Нет способа заставить JavaDoc работать на пустом пакете. Существует действительно старая ошибка , помеченная как "Закрыто, не исправит".

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

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