gradle - 如何将文档添加到Gradle插件扩展变量中？

Question

好吧，让我们尽可能简化这个问题。

我正在尝试构建Gradle插件。我有一个扩展名为MyExt。

open class MyExt {

    /**
     * <p>This is some sample docs</p>
     */
    var myVar: String = "myVar is awesome"
}

这是我的插件

class MyAwesomePlugin : Plugin<Project> {


    override fun apply(project: Project) {

        val myExt : MyExt = project.extensions.create("my-awesome-plugin", MyExt::class.java)

        ...
    }

}

当我尝试在项目中实现此插件时，IntelliJ不会像显示其他Gradle变量那样显示 myVar的文档。

不显示myVar



但显示Gradle变量



我在存储库中同时包含了 sources和 docs jar。

为什么不显示变量doc？我想念什么？

如何在Gradle插件的扩展变量中添加文档？

Answer 1

TLDR；这是一个bug

确保您具有正确的文档格式:请参阅Documenting Kotlin Code。对我来说，它适用于以下注释:

/**
* This is some sample docs
*/

还要确保已应用了插件并重新导入了Gradle项目: