Как запустить API документацию в браузере от IntelliJ IDEA

2910
user4955663

Я только что скачал IntelliJ IDEA и пытаюсь с этим что-то сделать. Я использую плагин Scala. Кажется, что IntelliJ загружает все библиотеки + javadocs, упомянутые в зависимостях проекта build.sbt.

Как запустить документацию по API на основе браузера от IntelliJ? Я ищу способ увидеть все классы в API.

Пример:

Я использую библиотеку scalajs-dom в своем проекте. Затем я хотел бы запустить следующую документацию (которую IntelliJ уже загрузил в мою систему) где-то внутри IntelliJ IDEA: http://www.scala-js.org/api/scalajs-dom/0.9.0/#org. scalajs.dom.package

На мой взгляд, Хорошим местом для запуска может быть окно проекта / внешние библиотеки / scalajs-dom, но его там нет.

Еще одно хорошее место может быть в редакторе: всякий раз, когда вы указываете, например, на класс, принадлежащий библиотеке scala.js, вы можете выбрать во всплывающем меню что-то вроде «Документация API», но ее там тоже нет.

РЕДАКТИРОВАТЬ: справка IntelliJ IDEA о внешних документах: https://www.jetbrains.com/idea/help/viewing-external-documentation.html

  • В моей IDEA (Community Edition v15.0.4) нет команды Внешняя документация в меню Вид
  • Нажатие Shift + F1 ничего не делает, даже если выбран класс, имеющий Javadoc
  • Окно быстрого просмотра документации стрелка вверх (= просмотр внешней документации) всегда отключено

Но в окне Project / внешних библиотеках выберите библиотеку, а затем откройте настройки библиотеки. Я вижу, что есть библиотеки, исходники и javadocs.

Окно быстрой документации работает нормально.

РЕДАКТИРОВАТЬ 2: Если я нажму Ctrl + Shift + A, IntelliJ откроет диалоговое окно «Ввод действия или имени параметра». Внешняя документация есть, но она серого цвета, я не могу выбрать ее или что-то сделать с ней.

3
если вы выделите ссылку и нажмете клавишу F1, запускается ли она с помощью контекстной помощи? Большинство IDE, которые я использовал за эти годы, используют F1, включая Eclipse и Visual Studio. очевидно, это также распространяется на IDEA: http://stackoverflow.com/questions/12840963/how-to-disable-help-in-intellij-idea. В браузере документов просто перейдите на уровень пакета для API. Frank Thomas 8 лет назад 0
При указании различных вещей и нажатии клавиши F1 я получаю следующее: Внешняя библиотека: https://www.jetbrains.com/idea/help/project-tool-window.html Класс в редакторе: https://www.jetbrains.com/idea /help/intellij-idea-editor.html Окно документа: https://www.jetbrains.com/idea/help/documentation-tool-window.html Таким образом, различные общие справки, но не документ API. user4955663 8 лет назад 0
https://www.jetbrains.com/idea/help/viewing-external-documentation.html CrazyCoder 8 лет назад 0
Я проверил ваш комментарий и отредактировал вопрос. user4955663 8 лет назад 0

2 ответа на вопрос

1
Bazi

Единственная причина View External Documentationотключения - это то, что IDEA не может найти файл javadoc для ваших классов. Вы должны убедиться, что есть javadoc-файлы для каждой зависимости, для которой вы хотите просмотреть документацию во внешнем средстве просмотра.

В IDEA вы можете щелкнуть правой кнопкой мыши по проекту и выбрать Maven -> Download Documentationналичие всех файлов Javadoc для зависимостей.

Вот еще один вопрос SO, который показывает, как прикрепить javadocs к выбранным зависимостям

0
Anton Dozortsev

Try to find action External Documentation by Ctrl+Shift+A search action feature. It must be in Code View Actions.

To enable Quick Documentation by passing Shift+F1 go to Project Structure and here in SDKs on Documentation Paths tab specify URL click on plus with the Earth.

enter image description here

So now Quick Documentation must work and View external documentation too.

Внешняя документация в поисковом действии является серой, я не могу выбрать ее. Быстрая документация работает нормально, она работает нормально с самого начала. user4955663 8 лет назад 0
@ Вы добавили URL для Java API? Anton Dozortsev 8 лет назад 0
Я попробовал два варианта: URL и локально установленный каталог Javadoc. В обоих случаях внешняя документация все еще была серой в «поисковых действиях», а не в меню «Просмотр». user4955663 8 лет назад 0
@ user4955663 Работает в версии IntelliJ Ultimatum Anton Dozortsev 8 лет назад 0

Похожие вопросы