Hi Guys, do you have any idea how to effectively g...

# javascript

[Márton Matusek]

Hi Guys,
do you have any idea how to effectively generate api documentation for Kotlin JS library targets? Thank you!

[CLOVIS]

What kind of API documentation? Source code API, like Dokka? Or HTTP API, like OpenAPI?

[Márton Matusek]

Source Code 🙂

[CLOVIS]

Dokka works well

[CLOVIS]

If you use MkDocs, see my experimental plugin; https://gitlab.com/opensavvy/automation/dokka-material-mkdocs

[Márton Matusek]

I would like to publish platform-specific documentation, not just multiplatform

[Márton Matusek]

I would like to have docs for the generated js code

[CLOVIS]

As in, you want documentation using JS syntax?

[CLOVIS]

My best guess then would be to generate documentation from the generated .d.ts with e.g. TypeDoc

[Márton Matusek]

I would like to make the API documentation availaibe for JS api consumers

[Márton Matusek]

That is a good idea 🙂 Thanks!
It would also be great if the jsdoc was included in the generated source

[CLOVIS]

You should probably create a feature request for that, I don't think it's possible at the moment: https://kotl.in/issue

[Márton Matusek]

Okay, thank you for your help!

[CLOVIS]

(if you do create an issue, share the link here, I'm curious to follow it)

[Márton Matusek]

Isn't this something like that? https://youtrack.jetbrains.com/issue/KT-4220/Generate-JsDoc-comments-for-code-generated-by-Kotlin

[CLOVIS]

It does, yeah, thanks for the link

[Márton Matusek]

You are welcome! There does not seem to be any activity on it, though 😞

[CLOVIS]

If you add a comment with an example of what you'd find this useful for, it may bring this to the attention

[Márton Matusek]

Good idea