okio
okio copied to clipboard
square
Missing javadocs
Since version 2.3.0 javadocs for many (not all) classes and methods are missing. This is how "quick documentation" looks like in Android Studio for 2.2.2 and 2.6.0:
Viewing docs in IDE is much faster than browsing through the website. Please fix it if possible.
As a minor side note, since v2.0.0 javadoc.jar is in Markdown format, which breaks compatibility with some third-party sites. Are there technical reasons for that? Couldn't find any info in changelog.
Looks like this broke when we introduced multiplatform. If anyone wants to dig in and fix, that’d be great. Otherwise we’ll get to it!
Well, I can copy docs from commonMain to jvmMain, but is this the right way to go? They may start to diverge after a while. I'm not familiar with multiplatform projects, so not sure how docs should be structured in this case.
It looks like IDE is reading the documentation from the actual classes/interfaces.
For example expect BufferedSource has documentation, while actual BufferedSource does not have documentation. And IDE only reads actual class, ignoring except one.
Maybe this is something that should be fixed from the IntelliJ / Jetbrains side? From what I see, only good solution is to copy over documentation to the actual classes and maintain duplicates.
I've created IntelliJ issue for this: https://youtrack.jetbrains.com/issue/KT-45795
I also recently noticed that at some point Dokka dropped support for Javadoc publication in multiplatform projects (https://github.com/Kotlin/dokka/issues/1753). Don't recall which version of Dokka Okio uses, but maybe this is the culprit? If yes - switching from dokkaJavadoc to dokkaHtml might be something to try, if anyone's interested.
