Como iniciar a documentação da API no navegador do IntelliJ IDEA

3

Acabei de fazer o download do IntelliJ IDEA e tentar fazer algo útil com ele. Estou usando o plugin scala. Parece que o IntelliJ faz o download de todas as bibliotecas + javadocs mencionadas nas dependências do projeto build.sbt.

Como posso iniciar a documentação da API baseada em navegador do IntelliJ? Estou procurando uma maneira de ver todas as classes em uma API.

Exemplo:

Eu uso a biblioteca scalajs-dom no meu projeto. Então eu gostaria de lançar a seguinte documentação (que o IntelliJ já fez o download em meu sistema) de algum lugar dentro do IntelliJ IDEA: link

Na minha opinião, um bom lugar para lançar isso pode ser a janela do projeto / bibliotecas externas / scalajs-dom, mas não está lá.

Outro bom lugar pode estar no editor, sempre que você apontar, classe pertencente à biblioteca scala.js, você pode selecionar no menu pop-up algo como "Documentação da API", mas ela também não está lá.

EDITAR: Ajuda do IntelliJ IDEA sobre documentos externos: link

  • No meu IDEA (community edition v15.0.4) não há um comando de documentação externa no menu Exibir
  • Pressionar Shift + F1 não faz nada mesmo quando é selecionada uma classe com javadoc
  • A seta da janela de pesquisa rápida da documentação para cima (= exibir a documentação externa) está sempre desativada

Mas na janela Project / bibliotecas externas, selecione um lib e, em seguida, abra as configurações da biblioteca. Vejo que há bibliotecas, fontes e javadocs.

A janela de documentação rápida funciona bem.

EDIT2: Se eu pressionar Ctrl + Shift + A, o IntelliJ abre a caixa de diálogo "Inserir ação ou nome da opção". A documentação externa está lá, mas está em cinza, não consigo selecioná-la ou fazer nada com ela.

    
por user4955663 02.03.2016 / 23:03

2 respostas

1

A única razão para o View External Documentation estar desabilitado é que o IDEA não pode localizar o arquivo javadoc para suas classes. Você precisa ter certeza de que existem arquivos javadoc para cada dependência para a qual você quer ver a documentação em um visualizador externo.

No IDEA, você pode clicar com o botão direito do mouse no projeto e selecionar Maven -> Download Documentation para ter todos os arquivos javadoc para dependências em vigor.

Aqui é outra pergunta sobre SO que mostra como anexar o javadocs a dependências selecionadas

    
por 12.03.2018 / 16:32
0

Tente encontrar a ação External Documentation em Ctrl + Shift + Um recurso de ação de pesquisa . Deve estar em Code View Actions .

Para ativar Quick Documentation passando Shift + F1 vá para Estrutura do Projeto e aqui na guia SDKs on Documentation Paths , especifique URL clique em mais com o Google Earth .

Então, agora Quick Documentation deve funcionar e View external documentation também.

    
por 04.03.2016 / 21:55