将 JS stdlib 链接到生成的 kdoc

问题描述

开发 Kotlin/JS 项目,我们使用 Dokka Maven 插件生成 KDoc。但是,标准 JS 库类在生成的文档中显示为 ERROR CLASS。

示例:具有这样的功能

fun HTMLElement.component(label: String,init: () -> Unit)

提供文档:

fun <ERROR CLASS>.component(label: String,init: () -> Unit)

我们支持代理并且 Dokka 插件配置为离线工作 (<offlineMode>true</offlineMode>)。我们如何将 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>

相关问答

Selenium Web驱动程序和Java。元素在(x,y)点处不可单击。其...
Python-如何使用点“。” 访问字典成员?
Java 字符串是不可变的。到底是什么意思?
Java中的“ final”关键字如何工作?(我仍然可以修改对象。...
“loop:”在Java代码中。这是什么,为什么要编译?
java.lang.ClassNotFoundException:sun.jdbc.odbc.JdbcOdbc...