Question

我正在寻找一种在所有Dokka生成的文档的页脚中包含文本的方法。我没有看到该选项由Dokka的Gradle或Maven插件发布。

这可能吗？你能指出一个例子吗？

Answer 1

dokka程序包中有两种实例方法–一种用于footer，一种用于header ：

fun appendFooter(to:) { }

fun appendHeader(to:, title:, basePath:) { }

real code如下所示：

package org.jetbrains.dokka

import java.io.File

interface HtmlTemplateService {

    fun appendHeader(to: StringBuilder, title: String?, basePath: File)
    fun appendFooter(to: StringBuilder)

    companion object {

        fun default(css: String? = null): HtmlTemplateService {
            return object : HtmlTemplateService {

                override fun appendFooter(to: StringBuilder) {
                    if (!to.endsWith('\n')) {
                        to.append('\n')
                    }
                    to.appendln("</BODY>")
                    to.appendln("</HTML>")
                }
                override fun appendHeader(to: StringBuilder, title: String?, basePath: File) {
                    to.appendln("<HTML>")
                    to.appendln("<HEAD>")
                    to.appendln("<meta charset=\"UTF-8\">")
                    if (title != null) {
                        to.appendln("<title>$title</title>")
                    }
                    if (css != null) {
                        val cssPath = basePath.resolve(css)
                        to.appendln("<link rel=\"stylesheet\" href=\"$cssPath\">")
                    }
                    to.appendln("</HEAD>")
                    to.appendln("<BODY>")
                }
            }
        }
    }
}

我认为即使在dokka.playground，它也必须能够正常工作。

希望这会有所帮助。

如何为Kotlin Dokka文档添加页脚？

1 个答案: