引用项目依赖项的javadoc

时间:2014-05-22 21:31:32

标签: gradle javadoc

我有几个项目,其中项目A是项目B的依赖项。因此,在项目B的build.gradle中:

dependencies {
    compile project(':A')
}

Project B的javadoc引用了项目A中的许多类,包括从抽象类和接口继承javadoc。但是,它们都显示为完全限定的类名,没有项目A的javadoc链接。可以理解,因为我没有以任何方式将它们联系起来。

是否可以让javadoc任务引用另一个项目的源?我可以将项目A的类放在项目B的javadoc中。 javadoc任务有source属性我可以设置为项目B和A的源集,我只是不确定如何引用项目A的源或者是否有更好的方法来执行此操作。

附注:链接到JDK / Guava / etc。 Javadoc,我正在设置javadoc.options.links。由于我没有在外部托管项目A的javadoc,我认为这不适用于此,但我不确定。

1 个答案:

答案 0 :(得分:0)

解决方案取决于您是要单独还是一起发布这些javadoc。后者通常就是这种情况,只需一个Javadoc任务即可解决它,它将在一次运行中处理所有源,然后知道如何交叉链接它们(参见Gradle代码库的工作方式 - https://github.com/gradle/gradle/blob/master/subprojects/docs/docs.gradle#L312)。如果要在同一站点上单独发布它们,可以尝试按正确顺序构建它们并使用相对路径进行链接。