1

我正在为我的公共 API/函数生成文档。它运作良好。但现在我想在文档中也包含示例（示例代码）。我知道我们可以使用@sample 实现它，但不知何故我无法做到。

/**
@sample com.example.samples.Samples.doStuffSample
*/
    fun doStuff(path: String, deviceID: String, newName: String,): Operation {
    // Do stuff here
}

这是我的示例类，其中有示例代码。

class Samples {

fun doStuffSample() {
    Manager.doStuff("path", "deviceID", "newName", object : Delegate {
        override fun onSuccess() {
            // Success
        }

        override fun onError() {
            // Error
        }
    })
}

}

这是 build.gradle 文件。

dokkaJavadoc.configure {
dokkaSourceSets {
    named("main") {
        skipDeprecated.set(true)
        skipEmptyPackages.set(true)
        includeNonPublic.set(false)
        reportUndocumented.set(true)
        perPackageOption {
            skipEmptyPackages.set(true)
            includeNonPublic.set(false)
            matchingRegex.set("//package name")
            suppress.set(false)
            matchingRegex.set("//package name")
            suppress.set(true)
        }
    }
}

}

在生成的文档中，我只能在“Samples”标题下方看到“com.example.samples.Samples.doStuffSample”。我怎样才能做到这一点？任何帮助表示赞赏。

4

0 回答 0