问题标签 [kotlin-dokka]

如果不使用来自文件系统根目录的完整绝对路径，我无法将 Dokka 配置为包含我的包的文档。我的 Gradle 文件中有（该includes行有问题）：

./gradlew dokka什么时候，如果我有这个错误，我会运行：

如果我删除$projectDir并使用绝对路径，则一切正常。可以改用相对路径吗？

我有一个多模块项目，我使用 dokka 为每个库（模块）生成 KDocs/Javadocs。我有一个包含多个项目的私人 gitlab，我想使用 gitlab 页面以某种方式index.html为我的所有模块和包上传所有这些生成的页面。

我的问题是这是否需要我将每个模块中的所有文档合并到一个index.html文件中，或者我是否可以实现将所有项目文档放在一个位置的相同目标，项目中的每个模块都拥有自己的index.html.

我正在寻找一种方法来自定义 Dokka 生成的 html 以包含自定义页眉和页脚。我以前使用过 Doclava 来覆盖生成的 HTML 的模板，并且想知道在 Dokka 中是否有办法做到这一点。查看他们的代码，我遇到了 appendHeader 和 appendFooter 函数，但不确定如何覆盖这些方法。https://github.com/Kotlin/dokka/blob/de2f32d91fb6f564826ddd7644940452356e2080/core/src/main/kotlin/Formats/KotlinWebsiteHtmlFormatService.kt#L10

我最后的手段是使用脚本修改生成的 html 文件，方法是在第一个正文标记之后插入标题并在结束标记之前插入页脚，但希望有一个更优雅的解决方案。

任何帮助将不胜感激。谢谢！

编辑：最终创建了一个 hacky bash 脚本

Dokka的官方文档说 Dokka 可以输出不同格式的结果：

输出格式

• html- 默认使用简约的 html 格式，Java 类被翻译成 Kotlin
• javadoc- 看起来像普通的 Javadoc，Kotlin 类被翻译成 Java
• html-as-java- 好像html，但 Kotlin 类被翻译成 Java
• markdown- 降价结构为html，Java 类被翻译成 Kotlin
  • gfm- GitHub 风格的降价
  • jekyll- Jekyll 兼容降价
• kotlin-website*- 用于kotlinlang.org文档的内部格式

虽然我在 kotlinlang.org（标准库和语言指南）上看到了一些格式，但我还没有看到其他格式。

html是否有任何指向以、javadoc或html-as-java格式生成的文档的链接？

需要使用 Dokka 生成内部文档，但我有那个错误......我不知道为什么

构建等级：应用程序

构建 gradle 项目

错误

谢谢大佬：）

我正在编写一个以 lambda 作为参数的 Kotlin 函数，例如

我想知道是否有办法将函数记录为输入，以便我可以参考value1或value2在文档中？

到目前为止做

没有奏效，dokka 将无法构建文档。

我正在尝试在 Android 项目中生成 KDoc 文档。以下是添加此功能的相关文件。

build.gradle（根级别）：

build.gradle（模块：应用程序）

后来，我./gradlew dokka从命令行运行。但是没有产生任何输出。以下是我得到的：

其实MainActivity里面有一个小demo脚本。我不确定为什么什么都没有生成。请让我知道我的配置是否正确。此外，拥有一个工作配置会很棒。

我使用 Dokka 为 View 子类生成了文档。效果很好，但文档包含 View 基类的数百个公共函数。有没有办法只记录我的子类公共功能？

我尝试将这些选项添加到 Gradle 任务中，但我认为这不是它的本意：

我正在使用 KDoc/Dokka 为 android 库生成文档。

我有一个自定义视图，它扩展了LinearLayout.

问题在于它LinearLayout包含数百个公共方法。Dokka 为所有这些方法生成空文档，即使我没有在我自己的代码中使用或覆盖它们。

这完全掩盖了我自己的任何方法，并使文档几乎毫无用处。

如何防止 dokka 为继承的方法生成文档？

我想在我的 Kotlin 文档中提供代码示例，我发现文档中有一个@sample <identifier>关键字。但我不确定我应该做什么。