Mill for Kotlin: Dokka

[robstoll]

Hi, still looking into how Mill could replace gradle in the context of Kotlin and wonder what it offer in the direction of code documentation. I see that it generates a javaDocJar but I don't see anything related to dokka and thus was wondering if anything like this exists already (or mkdoc or whatever)

[lihaoyi]

@robstoll the docJar that Mill generates uses Dokka automatically for KotlinModules. You can see that in the command-line trace below

$ wget https://repo1.maven.org/maven2/com/lihaoyi/mill-dist/1.0.1/mill-dist-1.0.1-example-kotlinlib-basic-1-simple.zip

$ unzip mill-dist-1.0.1-example-kotlinlib-basic-1-simple.zip 

$ cd mill-dist-1.0.1-example-kotlinlib-basic-1-simple 

$ ./mill show foo.docJar
"ref:v0:dc9a84f2:/Users/lihaoyi/test/mill-dist-1.0.1-example-kotlinlib-basic-1-simple/out/foo/docJar.dest/out.jar"

$ cp out/foo/docJar.dest/out.jar .

$ unzip out.jar 

$ open index.html 

[robstoll]

ah alright, where do I find the documentation about how to configure it? https://mill-build.org/mill/kotlinlib/module-config.html#_doc_jar_generation mentions kotlinDocOptions but I don't find anything about it in the docs nor in this github repo (apart from this discussion now 🙂 )

[lihaoyi]

@robstoll looks like the docs have the wrong name, should be def dokkaOptions https://github.com/com-lihaoyi/mill/blob/main/libs/kotlinlib/src/mill/kotlinlib/KotlinModule.scala#L250

[robstoll]

thanks for the pointer, that would have answered also my initial question.

[robstoll]

I can fix this in the docs if you like (and maybe other issues in the docs in the future) but I need another pointer. I cannot find an "edit on github" button in the documentation (that would be the easiest access for readers IMO). https://github.com/com-lihaoyi/mill/blob/main/website/docs/modules/ROOT/pages/kotlinlib/module-config.adoc indicates it should take it from 9-docjar.adoc but I don't see where this one is defined.

[lihaoyi]

Should be fixed by #5593