I have a bunch of kotlin files, and I use KDoc com...

# dokka

[Lee Griffiths]

I have a bunch of kotlin files, and I use KDoc comments inside of them. I want to provide some documentation describing a package as a whole. How do I do that?

There's a page here that suggests it's possible:
https://kotlinlang.org/docs/dokka-module-and-package-docs.html

But it provides 0 details on how to do this, it just says "Documentation for a module as a whole, as well as packages in that module, can be provided as separate Markdown files." without telling me what the path of these files should be.

When googling for the kotlin equivalent of package-info.java you find a lot of links to dead pages/anchors at http://kotlinlang.org/docs/reference/kotlin-doc.html#module-and-package-documentation but I'm not sure if that's the same contents as the above, or not.

[Oleg Yukhnevich]

Hey!
you can take a look on how it's configured in an example project which is referenced on Module documentation page
Though, it's not directly equivalent to documentation inside package-info.java as it will only affects how Dokka will HTML API reference

[Lee Griffiths]

So you have to manually add all of the package.md (or whatever) files yourself? Seems tedious.

Do the people at JetBrains not believe in package-level documentation, or something? :)

[CLOVIS]

You can create a single one if you want, they don't have to be different files

[CLOVIS]

(but to answer your question, many teams at JetBrains indeed don't use package-level documentation)