A modern programming language that makes developers happier.

kotlinlang

image.png

Is anyone on the Ktor team currently working on improving the `KDoc` on published APIs?

Consider this following screenshot. Do you consider that an acceptable level of commentary in a flagship library? Most public Ktor APIs suffer from the

```/**
 * Performs action.
 */
public fun performAction()```
problem. It conveys no information whatsoever while not mentioning critical information. For example here the KDoc doesn't even mention that the `incoming` channel filters out `Ping`, `Pong` and `Close` frames.

I always thought that we were waiting for the 2.0 release before all the documentation gets fixed (no point documenting API that's due for a breaking change), but it's 2.2.2 already and documentation is still missing.

Thanks for the feedback. We have focused so much on the actual documentation, and mostly ignored the API. We need to do better.