/ / Gerando o javadoc ao salvar no Eclipse - java, eclipse, maven, javadoc

Gerando o javadoc ao salvar no Eclipse - java, eclipse, maven, javadoc

Estou gerando o Javadoc do meu projeto usando maven (com o javadoc:javadoc objetivo). Eu também configurei o Javadoc Localização propriedade do meu projeto para a pasta onde mavengera o Javadoc. Então, posso ver facilmente o Javadoc completo de uma classe da visualização Javadoc do Eclipse selecionando "Abrir Javadoc Conectado em um Navegador".

No entanto, toda vez que faço algumas alterações na documentação, preciso recriar explicitamente a documentação com o maven, antes de poder ver as atualizações da documentação no navegador.

Existe uma maneira de instruir o Eclipse a gerar automaticamente os arquivos Javadoc quando um arquivo é salvo?

Eu sei que isso provavelmente não é uma boa idéia quando nãofocado em escrever documentação, já que isso pode desacelerar um pouco o Eclipse. No entanto, quando minha principal tarefa é escrever documentação, um pouco de automação nesse sentido será apreciado. Eu acho que a solução correta passa atualizando a documentação apenas dos arquivos que foram salvos (e não acionando todo o processo de geração do Javadoc), mas não sei se isso é possível.

Respostas:

1 para resposta № 1

Se você está usando o Integração Maven para Eclipse (m2e), você pode configurar um filtro de execução de plugins para que m2e saiba que você deseja que uma execução de plug-in específica também seja executada no Eclipse. Você desejaria que o plugin fosse executado em segundo plano:

       <execute >
<runOnIncremental>true</runOnIncremental>
</execute >

O outro lado disso tudo é que ele executará toda a execução do Javadoc sempre que você salvar alguma coisa, incremental é enganador nesse sentido. Pode entupir o seu Eclipse, e não apenas "um pouco", como você diz na pergunta atualizada. Toda execução de plug-in que faz mais do que o trivial absoluto deve ser fortemente examinada.

Uma solução verdadeiramente incremental não virá deMaven, já que não tem sentido que apenas partes do projeto tenham que ser construídas. Em vez disso, você precisaria do Eclipse para fazer isso diretamente. Eu acho que a mesma coisa acontece para a compilação de Java: isso é feito pelo próprio Eclipse, de forma incremental. No entanto, de acordo com o FAQ do Javadoc:

A9 Posso criar de forma incremental um documento a partir de diferentes execuções do Javadoc?

Basicamente não (...)

Chamamos isso de compilação incremental e estamos considerando isso para uma versão futura.

Mas nada é impossível :)