Как настроить страницу «Обзор» в JavaDoc?

Question

Я хочу, чтобы страница javadoc моей библиотеки была «администратором»/API для всего JAR. Я знаю, что добавление класса package-info.java в пакет позволяет вам написать пакетный код javadocs, но как насчет на jar-level?

Я знаю, что я мог бы поставить README.md в корне моего проекта, но мне нравится думать о README лет как документ для разработчиков библиотеки (то есть, люди, которые будут поддерживать библиотеку). Но JavaDocs являются справочниками API для людей, которые будут , используя библиотеку.

Answer 1

Вы можете создать общий HTML-файл и поместить его в любом месте в исходном дереве. Соглашение состоит в том, чтобы назвать его overview.html и поместить его в корень вашего дерева, но вы, конечно, не обязаны это делать. Фактически, вы можете создавать несколько файлов обзора для разных целей. Когда вы создаете свои javadocs, вы используете флаг -overview и передаете ему путь к целевому файлу обзора.

Дополнительную информацию о требованиях к файлу обзора см. here.