Doxygen и package.html

Question

В соответствии со спецификациями javadoc я поместил файл документации с именем package-info.html в корневой каталог соответствующего пакета.Однако когда я запускаю Doxygen в этой папке, документация в этом файле не берется.Как сказать Doxygen, чтобы использовать этот файл в качестве документации к пакету?Я также пробовал package.html, старую спецификацию, но она не работает.

Answer 1

Новый альтернативный способ предоставления документации для пакета Java - использовать файл с именем package-info.java вместо package.html.(Имя файла намеренно выбрано, чтобы не быть допустимым именем класса.)

Он имеет другой синтаксис:

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

Это также единственный способ предоставления аннотаций пакетов (которыеперед ключевым словом package, если есть).

Из ваших комментариев к вопросу похоже, что последние версии Doxygen понимают только этот package-info.java, а не старый package.html файл.

Я вспоминаю, что была предложена модульная система, которая затем добавила бы аналогичный module-info.java файл, но я не нахожу его сейчас после короткого поиска в Google.(Может JSR 294?)