问题标签 [kotlin-dokka]

AFAIK Kotlin 的文档是使用 Dokka 制作的。但是Dokka 的自述文件中所述的示例仅生成超基本的网页/降价文件，没有任何优雅。

它看起来像这样

这是Atrium的另一个，文档链接。

我想知道我是否做错了什么。

我还查看了问题页面并浏览了其他使用Dokka的开源 github 项目，结果始终相同。

现在一个很好的例子说明如何生成漂亮的文档的工具是Jazzy by Realm for Swift/Obj-C。使用它就像在终端上运行一个命令一样简单。

这是使用 Jazzy 创建的示例文档

进一步的研究表明，我可能必须使用Gitbook或Jekyll等第三方工具来生成我正在寻找的那种文档，这真的是唯一的方法吗？

我已经在 top build.gradle 中实现了 dokka

在核心模块中，我有想要记录的界面：

当我运行 dokka 任务时，我收到警告

有没有办法在文档中使用第三方库？我想将其配置为引用 github 源代码（https://github.com/f2pratek/rx-preferences）。已经尝试通过“externalDocumentationLink”配置它，但没有运气，找不到任何引用此库的 javadoc/package-list。

如果您单击文档中的 android.content.SharedPreferences，您将被重定向到https://developer.android.com/reference/android/content/SharedPreferences.html，我想为 rxprefs 实现相同的行为（重定向到 github）

UPD：dokka 配置从根 build.gradle 移动到应用程序的：

我添加了一些外部文档部门，但仍然收到很多警告，例如

或者

也许不可能有那种依赖关系的链接？我只想记录我的代码，但有框架和第三方依赖项的外部链接，这是真的吗？

我的object项目中有以下内容

如您所见，我想PARAM在该方法的 KDoc 注释中引用该字段的值，appendParameter但是在查看该注释时，我看不到实际值，而只看到该字段的名称。

将 PARAM 参数附加到 url 的方法

我想要的是：

将任何参数附加到 url 的方法

在 Javadoc 中，这通过 using 起作用，{@value PARAM}但在 KDoc 中似乎没有类似的东西。甚至自动代码转换器也保留了旧的 Javadoc。

所以我的问题是：是我遗漏了什么还是 KDoc/Dokka 遗漏了这个功能？

我有一个 Android 应用程序（app模块）和一个 Android 库模块（lib模块），每个都是一个单独的 Android Studio 项目，但应用程序项目lib作为模块依赖项添加到其项目中。

使用libJetBrain 的Dokka生成 HTML 文档，需要 Dokka Android Gradle 插件，该插件定义在自己项目的顶层build.gradle：

在lib模块中，build.gradle我必须添加以下内容

因此，现在该lib项目可以正常工作并且构建良好，并且我能够使用 Dokka 生成文档 HTML。

但是，我的应用项目的 Gradle 同步现在失败，因为它显示“未找到 ID 为 org.jetbrains.dokka-android 的插件”。如果我将它添加classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:0.9.18"到我的应用程序项目的顶级，build.gradle那么它工作正常。

我的问题是，我如何告诉主（应用程序）项目 Dokka 的类路径依赖项已经在lib模块的顶层声明build.gradle？或者有没有办法只为lib模块指定这种依赖关系？我也认为如果我有多个应用程序使用我的lib模块并且他们需要添加这个类路径依赖项才能构建他们的应用程序，这很奇怪。

非常感谢。

我想离线运行 Dokka 来生成文档，因为构建运行系统不需要互联网访问，因此需要离线生成文档。

可能吗？如果是，请提出相同的建议。

谢谢比奈

由于它似乎无法离线工作，因此没有可用的信息。

如何将（经过测试的、非陈旧的）代码示例包含到 Dokka 包文档中？

更具体地说，假设我在我的build.gradle.kts：

然后是一些测试代码：

还有一个包文档 Markdown 文件：

，如何将println(...)-part 包含到文档中？当前版本的 Dokka 是否完全支持它？

交换或替换#没有做任何事情。.@sample@includeFunction

此外：

• 这是一个相关的问题，将近两年没有回答。
• 这是 2012 年的一些讨论，现在几乎完全由死链接组成。

我有一个带有注释的方法的spring boot项目，例如：

当我使用 dokka 生成 kdoc 时，PreAuthorize不包含注释。这是生成的kdoc：

有没有办法在生成的文档中包含注释？

所以我在伴随对象中有这组常量：

当我执行dokka时，与常量相关的注释在文档中的格式不正确......如何对多个常量使用一个描述？

我在 Kotlin的伴生对象中有以下参数

问题是，在Kdoc结果中，我按字母顺序找到它们

ARTIST_IDS_KEY

const val ARTIST_IDS_KEY：字符串

CONNECTION_AUX

const val CONNECTION_AUX：字符串

CONNECTION_蓝牙

const val CONNECTION_BLUETOOTH：字符串

CONNECTION_KEY

设备可以具有的各种连接类型的值。

const val CONNECTION_KEY：字符串

连接_USB

const val CONNECTION_USB：字符串

DEVICE_ID_KEY

设备和媒体元素的唯一 ID。

const val DEVICE_ID_KEY：字符串

GENRE_IDS_KEY

const val GENRE_IDS_KEY：字符串

MEDIA_ID_KEY

const val MEDIA_ID_KEY：字符串

MEDIA_NAME_KEY

您可以在 getMediaItems 返回的 Bundle 中找到各种键。

const val MEDIA_NAME_KEY：字符串

SONG_IDS_KEY

const val SONG_IDS_KEY：字符串

...有没有办法维持原始订单？

我的项目结构是一个多模块，每个模块都有相同的 dokka 任务

gradle dokka 插件给了我一些非常奇怪的结果：

首先，它通常需要我构建的一些工件，例如其他 modules.jar 文件，如果抱怨它不存在的话。据我了解，这没有多大意义，因为所有来源都存在。

接下来我注意到的是，dokka 只是在喜欢的时候生成文档。这听起来有点不准确，因为我在这里看不到任何规则。当我删除我的文档文件夹并再次启动 dokka 任务时，dokka 通常什么都不做。