如何为Liferay Javadoc Gradle插件配置destinationDir参数

Hey there! As someone who's worked with Liferay and Gradle, I totally get how confusing this can be when you're starting out. Let's break down how to fix your missing Javadoc issue and properly configure the destinationDir property.

1. 先找到默认Javadoc的生成位置 #

就算没手动设置destinationDir，任务也会把文档输出到某个地方——只是你可能没找对位置。运行javadoc任务时，仔细看Gradle控制台的输出，找类似这样的行：

Generating Javadoc to /path/to/your/project/build/docs/javadoc

这是大多数Gradle Javadoc任务的默认路径，但Liferay插件可能会调整到build/liferay-javadoc或者模块构建目录下的某个子文件夹。找到这个路径后，直接通过文件系统导航过去，或者在Eclipse里右键项目选择Show In > System Explorer，跳转到build文件夹里找。

2. 正确配置Liferay Javadoc插件的destinationDir #

如果你想自定义输出路径，不需要新建任务——直接修改build.gradle里已有的javadoc任务就行：

javadoc {
    // 设置你想要的输出目录（根据需求调整路径）
    destinationDir = file("$projectDir/docs/javadoc")
    
    // 可选：如果Javadoc生成时提示缺少依赖，添加Liferay相关的classpath
    classpath += configurations.compileOnly
    classpath += configurations.runtimeOnly
}

如果你用的是专门的com.liferay.javadoc插件，可能需要配置它的扩展项：

liferayJavadoc {
    destinationDir = file("$buildDir/custom-javadoc")
}

添加完配置后重新运行javadoc任务，文档就会出现在你指定的路径里了。

3. 自定义Javadoc任务（如果默认任务不好用） #

要是修改默认任务行不通，自定义任务能给你完全的控制权。下面是适配Liferay项目的示例：

task generateCustomJavadoc(type: Javadoc) {
    // 包含项目所有Java源文件
    source = sourceSets.main.allJava
    
    // 确保classpath包含Liferay所需的所有依赖
    classpath = sourceSets.main.compileClasspath
    classpath += configurations.compileOnly
    classpath += configurations.runtimeOnly
    
    // 设置你偏好的输出目录
    destinationDir = file("$projectDir/src/main/resources/static/javadoc")
    
    // 可选：添加Javadoc额外配置，比如显示作者信息、链接外部文档
    options.author()
    options.links("https://docs.liferay.com/portal/7.4/javadocs/")
}

运行这个自定义任务的话，执行./gradlew generateCustomJavadoc就行，或者在Eclipse的Gradle Tasks视图里找到它并运行。

4. 在Liferay IDE（Eclipse）里验证 #

任务执行成功后：

• 在Package Explorer里右键你的项目
• 选择Show In > System Explorer
• 直接导航到你配置的destinationDir路径——HTML格式的Javadoc文件就在那里，打开就能查看。

内容的提问来源于stack exchange，提问作者Ernesto Schiavo