Skip to content

Commit

Permalink
update all-modules-page-plugin workaround, and minor tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
aSemy committed Dec 16, 2023
1 parent dc6aa5c commit a496595
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ plugins {

dokkatoo {
moduleName.set("Basic Project")

dokkatooSourceSets.configureEach {
documentedVisibilities(
VisibilityModifier.PUBLIC,
Expand Down Expand Up @@ -127,10 +128,12 @@ dokkatoo {
)
footerMessage.set("(C) The Owner")
}

dokkatooPublications.configureEach {
suppressObviousFunctions.set(true)
suppressObviousFunctions.set(false)
}

// The default versions that Dokkatoo uses can be overridden:
versions {
jetbrainsDokka.set("1.9.10")
Expand Down Expand Up @@ -161,8 +164,15 @@ dependencies {
dokkatoo(projects(":subproject-world"))

// A dependency on all-modules-page-plugin is required at the moment, see https://github.com/adamko-dev/dokkatoo/issues/14
// A version is not required, Dokkatoo will automatically add one.
dokkatooPluginHtml("org.jetbrains.dokka:all-modules-page-plugin")
// If using Dokkatoo v2.1.0+ version is not required, Dokkatoo will automatically add one.
dokkatooPluginHtml("org.jetbrains.dokka:all-modules-page-plugin")

// Earlier versions of Dokkatoo must add a dependency:
dokkatooPluginHtml(
dokkatoo.versions.jetbrainsDokka.map { dokkaVersion ->
"org.jetbrains.dokka:all-modules-page-plugin:$dokkaVersion"
}
)
}
```

Expand Down

0 comments on commit a496595

Please sign in to comment.