Объедините Javadoc для нескольких модулей в одну коллекцию - PullRequest
9 голосов
/ 28 июня 2011

У меня есть Java-приложение, состоящее из нескольких модулей.Я хотел бы сгенерировать Javadoc для всех их вместе: то есть из этих нескольких модулей я бы хотел одну коллекцию файлов HTML с одним index.html, одним allclasses-frame.html и т. Д.гиперссылки должны работать между модулями.

Я использую Maven, но я не обязательно ограничен решениями, специфичными для Maven.Это будет выполнено заданием cron, чтобы можно было использовать другие инструменты.

Какой самый простой способ автоматической генерации Javadoc в этом случае?

Ответы [ 2 ]

3 голосов
/ 28 июня 2011

Если вы можете управлять им, javadoc может генерировать объединенную документацию при условии, что вы объединяете источники ввода. Возможно, есть более элегантное решение; но почему бы не скопировать все источники в объединенное дерево и затем запустить javadoc?

Другой вариант заключается в использовании опции -link, при которой документация одного сайта ссылается на документацию другого сайта. Обратите внимание, что если вы выберете эту опцию, вы также можете захотеть взглянуть на опцию linkoffline для гибкости в ваших сборках javadoc (если вам не удастся развернуть документацию на веб-серверах в правильном порядке, прежде чем она понадобится в последующих сборках).

1 голос
/ 28 июня 2011

Если вы используете eclipse IDE, то есть опция для генерации javadoc для вашего проекта в меню проекта.Для более подробной информации проверьте эту ссылку

...