在Eclipse中保存时生成javadoc

时间:2013-10-08 14:33:05

标签: java eclipse maven javadoc

我正在使用maven(javadoc:javadoc目标)生成项目的Javadoc。 我还将项目的 Javadoc Location 属性配置到maven生成Javadoc的文件夹中。然后,通过选择“在浏览器中打开附加的Javadoc”,我可以很容易地从Eclipse Javadoc视图中看到类的完整Javadoc。

但是,每次我在文档中做一些更改时,我都需要使用maven显式重新创建文档,然后才能在浏览器中看到文档更新。

有没有办法可以指示Eclipse在保存文件时自动生成Javadoc文件?

我知道,如果不专注于编写文档,这可能不是一个好主意,因为它可能会减慢Eclipse的速度。但是,当我的主要任务是编写文档时,在这个意义上的一点自动化将是值得赞赏的。我想通过更新仅保存文件的文档(而不是触发整个Javadoc生成过程)来通过正确的解决方案,但我不知道是否有可能这样做。

1 个答案:

答案 0 :(得分:1)

如果您正在使用Maven Integration for Eclipse (m2e),则可以设置plugin execution filter,以便m2e知道您希望在Eclipse中执行特定的插件执行。你想让插件在后台运行:

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

这一切的另一面是,无论什么时候保存,它都会运行你的整个Javadoc执行, incremental 在这个意义上是误导。它可能会阻塞你的Eclipse,而不仅仅是“有点”,就像你在更新的问题中说的那样。每个插件的执行都要经过严格的审查。

真正的增量解决方案不会来自Maven,因为它不知道只需要构建项目的一部分。相反,您需要Eclipse直接执行此操作。我认为Java编译也会发生同样的事情:它是由Eclipse本身逐步完成的。但是,根据Javadoc FAQ:

  

<强> A9。我可以从不同的Javadoc运行中逐步构建文档吗?​​

     

基本上没有(...)

     

我们称这种增量构建正在考虑将来发布。

但没有什么是不可能的:)

相关问题