Tag: kotlin dokka

Dokka – 跳过为默认的android包生成javadoc: 我正在尝试使用Dokka插件为Android Kotlin应用程序生成Javadoc。我把插件添加到我的gradle中： classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.9.15" 然后我按照项目说明做了一个基本配置： dokka { outputFormat = 'javadoc' outputDirectory = "$rootDir/docs" skipEmptyPackages = true noStdlibLink = true } 我使用基本的gradle命令生成文档： [user@linux AppDir]$ bash gradlew dokka 输出是好的，但它包括从我已经添加到我的项目的android或插件的多个目录，例如： android.R android.support com.google com.crashlytics . . . etc. 我如何跳过这些包？有什么办法只为我的/ app / scr / java文件夹和我创建的文件生成码头吗？任何帮助表示赞赏。

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

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

生成kdoc并在浏览器中观看: 我不知道如何在浏览器中观看生成的kdoc 。我正在用Kotlin为Android开发，并在gradle中添加了dokka作为依赖。新的dokka任务运行没有错误。我在Projects build.gradle添加了dokka作为依赖build.gradle dependencies { … classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:0.9.13" } 并在我的应用程序build.gradle中应用build.gradle apply 'kotlin-android' apply 'kotlin-android-extensions' apply 'org.jetbrains.dokka' 但是我找不到项目文件夹中的输出。我怎样才能在浏览器中看到输出或在哪里？谢谢编辑1：IDE：Intellij; Kotlin版本：1.1.1 编辑2（11.04.2017）： build.Gradle ： dokka { outputDirectory = "$buildDir/docs" }

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

什么版本的Dokka跟什么版本的Kotlin一起？: 只要Kotlin和Dokka版本不兼容，在Gradle和Maven构建中，事情可能会突然出现。我找不到任何地方的两个兼容版本的列表。什么是版本兼容性？注意：这个问题是由作者故意写的和回答的（自我回答的问题），所以对于常见的Kotlin话题的习惯性的回答是在SO中。

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

Kotlin Dokka支持哪些插件？: 我已经为Javadoc编写了一个工具来生成包和类的UML图。它使用Javadoc模型来生成相应的图并将它们插入到Javadoc页面中。我可以/怎么去做在Dokka为Kotlin代码同样的事情？我将如何处理Kotlin和Java类的代码？谢谢。

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