将 JS stdlib 链接到生成的 kdoc
Linking JS stdlib to generated kdoc
开发一个 Kotlin/JS 项目,我们正在使用 Dokka Maven 插件生成 KDoc。然而,标准 JS 库 类 在生成的文档中显示为错误 CLASS。
示例:具有如下功能:
fun HTMLElement.component(label: String, init: () -> Unit)
提供文档:
fun <ERROR CLASS>.component(label: String, init: () -> Unit)
我们在代理后面,Dokka 插件配置为离线工作 (<offlineMode>true</offlineMode>
)。我们如何 link 将 stdlib 文档添加到生成的文档中?
编辑: 似乎与 Dokka Maven 插件有关,Gradle 文档生成正常。
我在别处得到了我的答案,所以我就把它放在这里关闭它。
需要做两件事:将 <platform>js</platform>
添加到插件配置,以及 运行 在打包阶段(推荐预集成测试阶段)后生成 KDoc。
示例配置:
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>dokka-maven-plugin</artifactId>
<version>...</version>
<executions>
<execution>
<phase>pre-integration-test</phase>
<goals>
<goal>dokka</goal>
</goals>
</execution>
</executions>
<configuration>
<offlineMode>true</offlineMode>
<platform>js</platform>
<apiVersion>...</apiVersion>
</configuration>
</plugin>
开发一个 Kotlin/JS 项目,我们正在使用 Dokka Maven 插件生成 KDoc。然而,标准 JS 库 类 在生成的文档中显示为错误 CLASS。
示例:具有如下功能:
fun HTMLElement.component(label: String, init: () -> Unit)
提供文档:
fun <ERROR CLASS>.component(label: String, init: () -> Unit)
我们在代理后面,Dokka 插件配置为离线工作 (<offlineMode>true</offlineMode>
)。我们如何 link 将 stdlib 文档添加到生成的文档中?
编辑: 似乎与 Dokka Maven 插件有关,Gradle 文档生成正常。
我在别处得到了我的答案,所以我就把它放在这里关闭它。
需要做两件事:将 <platform>js</platform>
添加到插件配置,以及 运行 在打包阶段(推荐预集成测试阶段)后生成 KDoc。
示例配置:
<plugin>
<groupId>org.jetbrains.dokka</groupId>
<artifactId>dokka-maven-plugin</artifactId>
<version>...</version>
<executions>
<execution>
<phase>pre-integration-test</phase>
<goals>
<goal>dokka</goal>
</goals>
</execution>
</executions>
<configuration>
<offlineMode>true</offlineMode>
<platform>js</platform>
<apiVersion>...</apiVersion>
</configuration>
</plugin>