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

Fix the javadoc artifact having no content in releases #5

Closed
mahozad opened this issue Jul 6, 2021 · 0 comments
Closed

Fix the javadoc artifact having no content in releases #5

mahozad opened this issue Jul 6, 2021 · 0 comments
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects

Comments

@mahozad
Copy link
Owner

mahozad commented Jul 6, 2021

The javadoc.jar artifact has no javadoc in it. For example, this javadoc for version 0.4.0 of the library.

See this post and this post and this page and also dokka homepage for setting up kdoc in Android.

Important

If the docs cannot be generated offline, add this block of code to the build script:

val dokka by tasks.getting(org.jetbrains.dokka.gradle.DokkaTask::class)
dokka.configure<org.jetbrains.dokka.gradle.DokkaTask> {
    dokkaSourceSets {
        named("main") {
            noAndroidSdkLink.set(false)
        }
    }
}

See this and this and Kotlin/dokka#1706 for more information about the noAndroidSdkLink property.

@mahozad mahozad self-assigned this Jul 6, 2021
@mahozad mahozad added the bug Something isn't working label Jul 6, 2021
@mahozad mahozad added this to To do in Roadmap via automation Jul 6, 2021
mahozad added a commit that referenced this issue Jul 7, 2021
This also fixes issue #5
@mahozad mahozad closed this as completed in daba5c0 Jul 7, 2021
Roadmap automation moved this from To do to Done Jul 7, 2021
@mahozad mahozad added the documentation Improvements or additions to documentation label Jul 7, 2021
mahozad added a commit that referenced this issue Jul 8, 2021
mahozad added a commit that referenced this issue Jul 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
Roadmap
  
Done
Development

No branches or pull requests

1 participant