Как добавить нижний колонтитул в документацию Kotlin Dokka? - PullRequest
Новая
       36

Как добавить нижний колонтитул в документацию Kotlin Dokka?

4 голосов
/ 03 мая 2019

Я ищу способ включить текст в нижний колонтитул всех документов, сгенерированных Dokka. Я не вижу, чтобы эта опция рекламировалась плагинами Gradle или Maven для Dokka.

Возможно ли это? Можете ли вы указать мне образец?

1 Ответ

0 голосов
/ 05 мая 2019

В пакете dokka есть два экземпляра метода - один для footer, один для header: 

fun appendFooter(to:) { }

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

Вот реальный код как это выглядит: 

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 .

Надеюсь, это поможет.

...