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, но я не нашел его сейчас после короткой googleing. (Возможно, JSR 294?)