如何将文档添加到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

1. 请确保您具有正确的文档格式：请参阅Documenting Kotlin Code对我来说，它可以处理以下评论：

/**
* This is some sample docs
*/

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