Tag: kdoc

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 ？我不确定它是做什么的。

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

KDoc：插入代码片段: 如何在Kotoc的默认文档工具KDoc中插入代码片段？在Java中，我可以使用以下内容： /** * Example usage: * * <pre> * <code>@JavaAnnotation * public void foo() { * // Code * } * </code> * </pre> */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface JavaAnnotation {} 在Kotlin似乎没有相同的地方。我尝试使用Markdown，但行结束后插入2个空格不换行。

Kotlin文档不支持“”这样的标签: 我正在写文档评论来描述一种方法。 /** * necessary * setType is to set the PendingIntend's request code */ 但它不会显示段落。如果我不使用 ，所有的文档都没有任何中断。它在Java类中工作，但是当涉及到Kotlin时，我不知道如何处理它。

如何在kotlin kDoc中使用@link和@code: 我试图文档的方法，并尝试使用@连接和@code在JavaDoc中。我知道kotlin有一个kDoc，但我找不到它们，或者至少是类似的东西。

什么是Kotlin内联文档的正确名称？: 由于KDoc文档生成引擎已经被Dokka所取代，Kotlin文档应该被称为“KDoc评论”还是“Dokka评论”？

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

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