Tag: kotlin dokka

Kotlin KDoc：文档？: 我在这里看到，在这里和那里引用了KDoc，相当于Kotlin的JavaDoc实用程序。但是，我找不到有关如何使用它的任何文档，更不用说如何定制它或将其集成到Maven或Gradle中。我知道Kotlin API文档是使用KDoc生成的，因为页面源代码有以下的HTML注释：那么，有没有关于如何使用KDoc的文档呢？

kotlin未解决的KDoc链接，但IntelliJ不喜欢导入修复它: import abc.MyClass.MyEnum; /// from Java /** * [MyClass.MyEnum] */ class efg () : MyClass.MyEnum { return MyClass.MyEnum.BiGNUMBER; } 我有类似于IntelliJ上面的东西…但它会确定导入为未使用 – 所以优化导入将删除它…但是，如果我不插入手动导入，然后在我的文档它将识别[MyClass .MyEnum] 不能解析我能做什么？

抑制关于“没有文件com.foo.Bar $ toString（）”的Dokka投诉？: 我正在使用Gradle Dokka插件0.9.16-eap-1生成一些Kotlin代码的文档。我是一个没有破窗户types的人，因此有点沮丧，插件生成吨的消息，我没有明确记录一个重写的方法，在基类中充分记录的类的消息，例如： package com.foo /** * A silly class to demonstrate silliness. */ class Bar : java.io.InputStream() { override fun read() = -1 override fun toString() = “BAZ!” } 对于这个class级，Dokka谴责： No documentation for com.foo.Bar$read() (Bar.kt:6) No documentation for com.foo.Bar$toString() (Bar.kt:7) 这有点乏味，因为我不想用复制粘贴文档冗余地冗余文档。看看Dokka README.md ，我看到的唯一相关配置选项是： dokka { … // Emit warnings about not […]

在哪里/如何为Kotlin软件包添加文档？: 在Java中，如果你想记录一个包，它必须放在package-info.class文件中。 Kotlin和KDoc仍然是一样的吗？我已经浏览了Kotlin的一些源代码，并且找不到它们的包文档在哪里编写。

如何生成与dokka上载资料库的javadoc jar？: 我最近迁移了一个java组件到kotlin。到目前为止，当我使用Maven发布插件时，它也自动生成了javadoc，它也被上传到oss.sonatype.com。另一方面，Dokka似乎并没有将发行版插件与开箱即可集成。因此，在上传到oss.sonatype.com之后，nexus拒绝发布validation错误，因为javadoc jar缺失。有没有与Maven发布插件的dokka集成？

如何用Kotlin Dokka记录主构造参数: 比方说，有一个类的主要构造函数有参数param ，我想解决（链接到实际的参数）在类的文档块。 /** Class A does something using [param]. @constructor constructs A with [param]. */ class A (param: Int) 但是，题注param被IDE强调说它不能解析符号param 。

无法让dokka在gradle / android项目上生成kotlin文档: 我正在关注https://github.com/Kotlin/dokka中的gradle插件部分。我也尝试了https://github.com/JetBrains/kotlin-examples/tree/master/gradle/dokka-gradle-example中的dokka-gradle-example示例。我使用的版本是： android: ‘23.1.1’ dokka: ‘0.9.6’ gradle-android-plugin: ‘1.5.0’ kotlin: ‘1.0.0-rc-1036’ 但我也尝试过从0.9到0.9.7的Dokka版本。输出的相关部分是： … :app:dokka FAILED :app:dokka (Thread[Daemon worker Thread 9,5,main]) completed. Took 0.766 secs. FAILURE: Build failed with an exception. * What went wrong: Execution failed for task ‘:app:dokka’. > com.intellij.mock.MockComponentManager.getPicoContainer()Lorg/picocontainer/MutablePicoContainer; * Try: Run with –debug option to get more log output. * Exception […]

如何用Kotlin Dokka记录主构造参数: 比方说，有一个类的主要构造函数有参数param ，我想解决（链接到实际参数）在类的文档块。 /** Class A does something using [param]. @constructor constructs A with [param]. */ class A (param: Int) 但是，题注param被IDE强调说它不能解析符号param 。

我如何继承KDoc文档？: 在Java的Javadoc中，有一种方法可以使用{@inheritDoc}标记继承子类中的方法文档。有没有办法在Kotlin的KDoc中做同样的事情？基本上，我想要做的是以下几点： abstract class Base { /** * Some KDoc documentation here. */ abstract fun foo() } class Derived: Base() { /** * Here is all the documentation from Base#foo's KDoc inherited. * * And here goes something more in addition. */ override fun foo() { /* … */ } }

Dokka使用完全合格的类名称: 我正在使用dokka为我自动生成javadoc。虽然当它遇到任何类不是从我的项目，它使用完全合格的名称。有没有可能只使用类名称，并使dokka提供一个链接呢？例如： java.lang.String getName() 我想要而不是java.lang.String具有链接到Java文档的 String 我的gradle配置： ext.simpleName = project.name.substring(project.name.indexOf('-') + 1, project.name.size()) dokka { outputFormat = 'javadoc' outputDirectory = "${rootProject.buildDir}/javadoc/$project.ext.simpleName" linkMapping { dir = 'src/main/java' url = "https://github.com/mibac138/ArgParser/blob/master/$project.ext.simpleName/src/main/java" } linkMapping { dir = 'src/main/kotlin' url = "https://github.com/mibac138/ArgParser/blob/master/$project.ext.simpleName/src/main/kotlin" } } 另外， linkMapping究竟是linkMapping ？我不确定它是做什么的。