Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Javadoc generated by Dokka does not show up in quick documentation lookup in Intellij IDEA #2033

Closed
vbieleny opened this issue Jul 21, 2021 · 2 comments
Labels
bug format: Javadoc An issue/PR related to Dokka's Javadoc output format or the Javadoc comments in general

Comments

@vbieleny
Copy link

Describe the bug
When a Javadoc generated by Dokka is imported in IntelliJ IDEA or Android Studio, it does not show up in quick documentation lookup for Kotlin files. It does show up for Java files, but only for methods and not for classes.

Expected behaviour
When I do quick documentation lookup with Ctrl + Q for some part of a code, I should be able to see Javadoc associated with it.

Screenshots
This is how the quick documentation lookup shows up
image

This is how it should show up
image

Intellj IDEA does have Javadoc JAR associated with the library
image

To Reproduce
Example project: https://github.com/vbieleny/dokka-javadoc-test

  1. Open the project in Intellij IDEA
  2. Execute task publishToMavenLocal in library module
  3. Open App.kt in app module and check the quick documentation lookup by pressing Ctrl + Q for the relevant code

Dokka configuration

dokkaJavadoc {
    dokkaSourceSets {
        named("main") {
            sourceRoots.from(file("src/main/java"))
        }
    }
}

Installation

  • Operating system: Windows
  • Build tool: Gradle v7.1.1
  • Dokka version: 1.5.0

Additional context
This happens in IntelliJ IDEA as well as in Android Studio, while generating Javadoc by using standard Javadoc tool works fine and documentation shows up in quick documentation lookup (only for Java files of course).

Are you willing to provide a PR?
If it's a bug, then I might, but I would need help with it.

@vbieleny vbieleny added the bug label Jul 21, 2021
@IgnatBeresnev IgnatBeresnev added the format: Javadoc An issue/PR related to Dokka's Javadoc output format or the Javadoc comments in general label Apr 22, 2022
@IgnatBeresnev
Copy link
Member

Some investigation into the current behaviour can be found in #2297 (comment)

@IgnatBeresnev
Copy link
Member

Closing this in favour of an older issue with more likes and information: #215

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug format: Javadoc An issue/PR related to Dokka's Javadoc output format or the Javadoc comments in general
Projects
None yet
Development

No branches or pull requests

2 participants