Sebastian Sellmair [JB]
07/30/2020, 4:52 PMPaweł Marks
08/04/2020, 12:07 PMZach Klippenstein (he/him) [MOD]
08/10/2020, 9:26 PMLukas K-G
08/12/2020, 12:29 PM1.4.0-RC
at my company. We had dokka 0.10.0
before and it worked, but with 1.4.0-RC
I get the following error in the Creating documentation models
phase: Couldn't get delegate for class
Does anyone have an idea what that could be or how to get any information what class causes this problem?addamsson
08/13/2020, 9:33 PMSebastian Sellmair [JB]
08/17/2020, 11:05 AMdev
build available that we would be very happy to get feedback for 🎉
_Build_: 1.4.0-dev-35
_____
Gist of changes:
1. Gradle Plugin
Our Gradle Plugin had some very hard to fix issues and we put a lot of effort into
• Reducing complexity of its implementation
• Fixing internal issues e.g. (bad UP-TO-DATE) behaviour,...
• Fixing UX issues like "re-declaring source sets for mulitplatform projects", replacing paths with java.io.File, using Gradles Property/Provider APIs etc...
We hope that "just applying the dokka plugin" is all that most build authors need. The plugin can be seen as companion to the Kotlin Gradle Plugin.
See the pull-request for further details: Simplify Gradle Plugin
Feel free to drop me dm's if you need any help migrating or experience any issues!
2. Merging visible source sets
Issue: DokkaCollectorTask: Merge source set bubbles
This was noticed while running the collector task on larger projects like the Spring framework.
Source sets with the same displayName and platform will now be represented as one in the frontend. We hope that this unblocks some of you that rely on the collector task.
3. Updated compiler to 1.4.0
4. A lot of smaller bugfixes
Further details are available in our milestones:
• 1.4.0
• Stable
__
Some comment on version numbers
You already noticed, that we aligned our version number to the compiler version we bundle. (e.g. 1.4.0, 1.4.0-rc, ...).
There were some minor hick-ups when we changed to this numbering schema, but I would like to clarify some things.
Dokka 1.4.* is not a stable project. It is still considered alpha!
For now, we agreed on using the following naming schema
• `{comiler-version}-dev-{build-number}`: for preview builds
• {compiler-verison}
for releases and pre-releases (no dokka maturity included)
• {compiler-version}-{patch number}
for patch releases
__
Some comment on kotlin-dev
This will probably be the last build we push to the kotlin-dev
repository. We will migrate dev builds to space packages in the near future.Sebastian Sellmair [JB]
08/18/2020, 4:14 PMjdkVersion = 8
-> jdkVersion.set(8)
• Any path of type String
is now represented as <http://java.io|java.io>.File
• Any collection of files/directories is now represented as Gradles ConfigurableFileCollection
• Make sure (especially in Android Projects) to configure Dokka tasks lazy: tasks.withType<DokkaTask>() { // config }
-> tasks.withType<DokkaTask>().configureEach { }
, tasks.getByName
-> tasks.named
,etc. Good read https://docs.gradle.org/current/userguide/task_configuration_avoidance.html
• Note: MPP projects will have all source sets automatically configured. No need for register
yourself!
• Tip: Use ./gradlew --stacktrace
to get better error messages of what is wrong. I noticed, that the short error message for Groovy scripts is not useful at all
And as always: Feel free to drop me a DM at any time you encounter an issue ☺️
Have fun, folks. Enjoy Kotlin 1.4.0 ☺️ 🎊Hadi Lashkari
08/20/2020, 8:09 AMtasks.dokkaHtml {
outputDirectory = "$buildDir/dokka"
dokkaSourceSets {
register("commonMain") {
displayName = "common"
platform = "common"
}
register("jvmMain") {
displayName = "jvm"
platform = "jvm"
}
register("androidMain") {
noAndroidSdkLink = true
displayName = "android"
platform = "android"
}
}
}
but when I run ./gradlew dokkaJavadoc
I got
No source set with name 'main' found
In the main directory is the AndroidManifest.xml
without a source! So how can I unregister the main
?elect
08/21/2020, 10:29 PMJavier
08/23/2020, 6:02 PMval dokkaJar by tasks.creating(Jar::class) {
archiveClassifier.set("javadoc")
from(tasks.dokka)
dependsOn(tasks.dokka)
}
jaguililla
08/27/2020, 5:02 PMSebastian Sellmair [JB]
08/28/2020, 3:22 PMmaven("<https://maven.pkg.jetbrains.space/kotlin/p/dokka/dev>")
elect
08/28/2020, 3:52 PM@sample
. I find cumbersome adding file by file in build.gradle.kts
under samples: List
. Wouldn't be possible for the plugin to group all the @sample
from the sources and find the least necessary common group of files to be used for doc inlining?oshai
08/28/2020, 9:45 PM0.10.0
) with Kotlin 1.4.0? After upgrading Kotlin version only (without upgrading dokka) I see some errors for KMP project.elect
08/29/2020, 12:12 PMdokkaJavadocJar
a
java.lang.OutOfMemoryError: Metaspacenever ever saw this before, is it normal? It seems
org.gradle.jvmargs=-XX:MaxMetaspaceSize=512m
in gradle.properties
solves the issueJorrit
08/29/2020, 5:45 PMmikehearn
09/01/2020, 2:41 PMNick Johnson
09/01/2020, 10:39 PMpniederw
09/02/2020, 5:19 PMRachel
09/04/2020, 9:16 AMOr Cohen
09/06/2020, 9:46 AMbuild.gradle.kts
script in which I apply the Dokka plugin to all libraries -
configure(subprojects.filter { it.parent?.name == "libs" }) {
apply {
plugin("org.jetbrains.dokka")
}
}
I’ve also added the following block that is mentioned in the docs for multi module support -
tasks.dokkaHtmlMultiModule.configure {
outputDirectory.set(buildDir.resolve("dokkaCustomMultiModuleOutput"))
documentationFileName.set("README.md")
}
I also have a README.md
file under each of my libraries under libs
folder, and I added the following to the build.gradle.kts
script of each of the libraries which I want to include in the generated docs -
tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {
dokkaSourceSets.configureEach {
includes.from("README.md")
}
}
After running dokkaHtmlMultiModule
, it seems like I get a folder for each library under build/dokkaCustomMultiModuleOutput/libs
(with all generated docs inside), but I can’t seem to find any top-level index.html
file. In addition, none of the libraries are listed in the top level -modules.html
file.
Am I missing something, or doing something wrong?
Thanks in advance 🙏dfriehs
09/09/2020, 6:08 PMincludeNonPublic
, which works for the base class, but prints the property for any and all derived classes:Robert Jaros
09/10/2020, 11:52 AMExecution failed for task ':dokkaHtml'.
> There was a failure while populating the build operation queue: NPM project resolved without org.jetbrains.kotlin.gradle.targets.js.npm.KotlinNpmResolutionManager@5fdc639
Anyone else has this issue?AJ Alt
09/11/2020, 12:49 AMdokkaHtml
task create index.html at the top level rather than nested in a project folder? It's not clear how to publish the output as a static site (e.g. github pages) without having the root 404.shelbycohen
09/14/2020, 10:23 PMFelix
09/15/2020, 1:03 PMtravisspencer
09/15/2020, 6:30 PMFelix
09/16/2020, 11:33 AMdokka/html
doesn't have any index.html
in the root folder (only a navigation.html
without any include stylesheet). The first index.html
appears only inside the module. Is this supposed to be this way?Michael
09/19/2020, 6:27 PMJulien Verfaillie
09/21/2020, 1:27 PM