2010-06-09 4 views
3

Я знаю, что могу использовать maven для вытягивания javadocs для артефакта (если они были добавлены), который должен появиться как JAR (справа?), Который я могу распаковать и просмотреть. Моя проблема в том, что я пытаюсь выяснить, какая из серии артефактов имеет конкретный пакет, на который я охотился. I может загрузить полдюжины пакетов javadoc, распаковать их все, а затем открыть индексные файлы по одному, но похоже, что это было бы довольно неприятно.Как просмотреть javadocs, которые были добавлены в репозиторий maven?

Должен быть лучший способ! Я заметил, что Nexus поддерживает просмотр артефактов javadoc, но, видимо, только в версии Pro (чего у нас нет, и вряд ли скоро получится). Я бы предпочел решение для графического интерфейса, хотя я бы согласился на ответ командной строки, если это что-то вроде строк showmethedocs groupId:artifactId [version].

ETA: Чтобы уточнить: я ищу специально для сравнения нескольких версий артефакта или нескольких разных, но похожих артефактов («foo: core» по сравнению с «foo: utils» по сравнению с «foo: extra» или что-то еще), когда Я не уверен, какой артефакт действительно содержит пакет/класс, который мне нужен. Может быть, есть лучший способ сделать это, и я задал неправильный вопрос? Если я добавлю каждый артефакт как зависимость от Maven и проверю документы в Eclipse, это может сработать, но если есть 20 старых версий артефакта, и точно один из них имеет метод, который я ищу, это может занять некоторое время.

+0

Если вы делаете скачать линию, кормчие рекомендуемым, Eclipse, то должны автоматически ассоциировать Javadocs с файлы классов. Если вы ищете определенный класс в Eclipse (меню навигации -> Open Type), он должен показать вам источник, если источник был загружен, и javadocs этого источника, когда вы наводите указатель мыши на использование этого пакета. Это не работает для вас? – Gray

+0

Конечно, было бы неплохо, если бы существовал облачный веб-сервис (например, read-the-docs), который позволяет просматривать javadocs, которые существуют для почти всех артефактов Maven. –

ответ

2

Если запустить

МВН затмение: затмение -DdownloadSources = True -DdownloadJavadocs = True

из корня вашего проекта, она будет загружать любые источники & Javadocs на удаленном хранилище на локальном хранилище. Если у вас есть m2eclipse, вы можете установить, что в настройках автоматически выполняются в фоновом режиме, а затем развернитесь до требуемой зависимости, щелкните правой кнопкой мыши, а затем скажите «открыть Javadoc». См:

http://www.sonatype.com/people/2008/10/browsing-javadoc-for-dependencies-in-eclipse-m2eclipse/

+0

Это очень приятно, хотя если я не хочу переключаться между командной строкой и графическим интерфейсом, я могу добавить каждый артефакт в качестве зависимости, щелкните правой кнопкой мыши в разделе «Зависимости Maven» и выберите «Загрузить Javadoc». Конечно, я хотел бы добавить/удалить их все, но это лучше, чем ничего. – Coderer

1

Если это за артефакт, который был опубликован в Maven Central вы можете использовать этот веб-сервис:

http://www.javadoc.io

Смежные вопросы