Skip to content

Update to Dokka 2.0.0 #483

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 9, 2025
Merged

Update to Dokka 2.0.0 #483

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
449fbaf
Update to Dokka 2.0.0
whyoleg Feb 11, 2025
ef0080b
Configure samples folders for all sourceSets
whyoleg Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion core/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,8 +383,10 @@ tasks.withType<AbstractDokkaLeafTask>().configureEach {
pluginsMapConfiguration.set(mapOf("org.jetbrains.dokka.base.DokkaBase" to """{ "templatesDir" : "${projectDir.toString().replace('\\', '/')}/dokka-templates" }"""))

failOnWarning.set(true)
dokkaSourceSets.named("commonMain") {
samples.from(kotlin.sourceSets.commonTest.map { it.kotlin.srcDirs })
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though we don't have them now, we could add samples to our platform-specific declarations as well. Can this ability be preserved without specifying every source set explicitly?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, sure! I will update the PR!

dokkaSourceSets.configureEach {
kotlin.sourceSets.commonTest.get().kotlin.srcDirs.forEach { samples.from(it) }
// reportUndocumented.set(true) // much noisy output about `hashCode` and serializer encoders, decoders etc
skipDeprecated.set(true)
// Enum members and undocumented toString()
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ versionSuffix=SNAPSHOT
tzdbVersion=2025b

defaultKotlinVersion=2.1.0
dokkaVersion=1.9.20
dokkaVersion=2.0.0
serializationVersion=1.6.2
benchmarksVersion=0.7.2
bcvVersion=0.17.0
Expand Down