v1.0.0

[aSemy]

What's Changed

Full Changelog: v0.0.4...v1.0.0

📚 Use Dokkatoo to document Dokkatoo #32

The Dokkatoo API is now documented using... Dokkatoo! Check it out: https://adamko-dev.github.io/dokkatoo/

📢 Reduce logging noise #34

Debug logging has been reduced. Dokkatoo is now quieter. A few warnings have also been fixed.

✂ remove Dokka code from public API, replace with equivalents #35

Dokkatoo no longer has a public dependency on Dokka. This makes development more flexible, but should have no impact if you have applied Dokkatoo solely via its Gradle Plugin ID.

ℹ️ If you have depended on Dokkatoo via its Maven coordinates, you probably also had to depend on Dokka Core. This should no longer be necessary:

// ./buildSrc/build.gradle.kts

dependencies {
  implementation("dev.adamko.dokkatoo:dokkatoo-plugin:1.0.0")
  // implementation("org.jetbrains.dokka:dokka-core:1.8.10") ⬅ no longer necessary
}

⚠ Breaking change - Improve Dokka plugin parameters DSL #36

Configuration for Dokka Plugins has been refactored.

• The API is now more convenient (no more manual JSON configuration),
• the XML format option was removed
• parameters are compatible with Gradle up-to-date checks (properties are correctly annotated with Gradle input annotations).

There is no migration support for this in the code. If you would like some help migrating please make an issue or discussion.

Example migration:

// build.gradle.kts

dokkatoo {
  dokkatooPublications.configureEach {
    pluginsConfiguration.create("org.jetbrains.dokka.base.DokkaBase") {
      serializationFormat.set(DokkaPluginConfigurationSpec.EncodedFormat.JSON)
      values.set(
        """
          { 
            "customStyleSheets": [
              "${file("./customResources/logo-styles.css").invariantSeparatorsPath}", 
              "${file("./customResources/custom-style-to-add.css").invariantSeparatorsPath}"
            ], 
            "customAssets": [
              "${file("./customResources/custom-resource.svg").invariantSeparatorsPath}"
            ] 
          }
        """.trimIndent()
      )
    }
  }
}

Should be replaced with:

// build.gradle.kts
import dev.adamko.dokkatoo.dokka.plugins.DokkaHtmlPluginParameters

dokkatoo {

  pluginsConfiguration.named<DokkaHtmlPluginParameters>("html") {
    customStyleSheets.from(
      "./customResources/logo-styles.css",
      "./customResources/custom-style-to-add.css",
    )
    customAssets.from(
      "./customResources/custom-resource.svg",
    )
  }
}

---

This discussion was created from the release v1.0.0.