32得票1回答
如何继承KDoc文档?

在Java的Javadoc中,有一种方法可以使用{@inheritDoc}标签,在子类中继承一个方法的文档。 在Kotlin的KDoc中是否有同样的方法呢? 基本上,我想做的是以下内容:abstract class Base { /** * Some KDoc docum...

15得票1回答
在KDoc中,有没有关于将Lambda作为函数参数进行文档化的约定?

我正在编写一个Kotlin函数,它接受一个lambda作为参数,就像这样 fun someFunction( param1: (value1: Boolean, value2: Boolean) -> Unit ) 我想知道是否有一种方法可以将函数作为输入进行文档化,这样我就可以在...

13得票1回答
你应该如何为 Kotlin 包添加文档?

在Java中,如果您想记录一个包(package),它必须被放置在package-info.class文件中。在Kotlin和KDoc中是否仍然是同样的情况? 我查看了一些Kotlin源代码,找不到他们的包(package)文档写在哪里。

12得票1回答
如何使用Kotlin Dokka记录主构造函数参数

假设有一个类,其主构造函数具有参数param,我希望在类的文档块内解析(链接到实际参数)该参数。 /** Class A does something using [param]. @constructor constructs A with [param]. */ class A (pa...

10得票2回答
Dokka:将代码示例包含在软件包文档中。

如何将(经过测试的,非陈旧的)代码示例包含到Dokka软件包文档中? 更具体地说,假设我在我的build.gradle.kts中有以下配置: withType<DokkaTask> { outputFormat = "html" outputDirector...

9得票1回答
将一个方法的KDoc文档复制到另一个方法

对于这两种给定的方法: /** * Adds a [DataItem] to the Android Wear network. The updated item is synchronized across all devices. */ fun putItem(){ .... } /*...

8得票4回答
无法在Gradle/Android项目中使用Dokka生成Kotlin文档

我正在遵循 https://github.com/Kotlin/dokka 中的 gradle 插件部分。 我还尝试了 https://github.com/JetBrains/kotlin-examples/tree/master/gradle/dokka-gradle-example 中...

8得票2回答
Dokka - 跳过为默认的Android包生成javadoc

我正在尝试使用Dokka插件为Android Kotlin应用程序生成Javadoc。 我将插件添加到我的gradle中: classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.15" 然后我按照项目说明进行了基本配置: dokk...

8得票5回答
Android Studio 3中找不到Dokka插件

我正在尝试在我的 Kotlin 项目中使用 dokka 插件,但是我收到以下消息: 错误:(7,0)找不到 Id 为 'org.jetbrains.dokka' 的插件。 我正在使用 Android Studio 版本 3.0. 提前致谢。

7得票1回答
Kotlin KDoc: 文档化?

我在这里,这里和那里都看到了关于KDoc的引用,它是针对Kotlin的JavaDoc工具。 然而,我找不到有关如何使用它甚至如何自定义它或将其集成到Maven或Gradle中的任何文档。 我知道Kotlin API doc是使用KDoc生成的,因为页面源代码包含以下HTML注释: <...