Документирование маршрутов Ktor с помощью KDoc

Кто-нибудь знает, как правильно документировать маршруты Ktor, чтобы показать их на KDoc? Пример:

route(DogoBot.data.API.ROUTE){
    route("token"){
        route("add"){
            get("fromdiscord") { ... }
            get { ... }
        }
    }
    route("user"){
        route("{id}") {
            get { ... }
        }
    }
    route("guild"){
        route("{id}") {
            get { ... }
        }
     }
}

Ну, если это возможно, как мне это сделать? Какую информацию я должен в нем указать? Как мне реализовать эту совместимость с Ktor в других вещах? (у меня есть еще один маршрутизатор, сделанный мной для других целей)


kotlin ktor documentation kdoc
person NathanPB    schedule 11.12.2018    source источник

Ответы (1)


arrow_upward
1
arrow_downward

Dokka не поддерживает маршруты Ktor, и я не знаю о каких-либо планах по добавлению такой поддержки, поэтому нет возможности включить информацию о маршрутах в сгенерированную документацию.

person yole    schedule 11.12.2018