tidy

Kotlin · Oct 17, 2024 · 8eb1a64 · 8eb1a64
1 parent 8c81b9b
commit 8eb1a64
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/examples/gradle-v2/custom-dokka-plugin-example/demo-library/build.gradle.kts b/examples/gradle-v2/custom-dokka-plugin-example/demo-library/build.gradle.kts
@@ -33,7 +33,7 @@ dokka {
 @OptIn(DokkaInternalApi::class)
 abstract class HideInternalApiParameters @Inject constructor(
   name: String
-) : DokkaPluginParametersBaseSpec(name, "demo.dokka.plugin.ogp.HideInternalApiPlugin") {
+) : DokkaPluginParametersBaseSpec(name, "demo.dokka.plugin.HideInternalApiPlugin") {
 
   @get:Input
   @get:Optional

diff --git a/...dokka/plugin/ogp/HideInternalApiPlugin.kt → ...emo/dokka/plugin/HideInternalApiPlugin.kt b/...dokka/plugin/ogp/HideInternalApiPlugin.kt → ...emo/dokka/plugin/HideInternalApiPlugin.kt
@@ -1,4 +1,8 @@
-package demo.dokka.plugin.ogp
+/*
+ * Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package demo.dokka.plugin
 
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.json.Json
@@ -23,24 +27,30 @@ class HideInternalApiPlugin : DokkaPlugin() {
   override fun pluginApiPreviewAcknowledgement() = PluginApiPreviewAcknowledgement
 
   companion object {
-    const val FQN = "demo.dokka.plugin.ogp.HideInternalApiPlugin"
+    const val FQN = "demo.dokka.plugin.HideInternalApiPlugin"
   }
 }
 
+/**
+ * Configuration for [HideInternalApiPlugin].
+ */
 @Serializable
 data class HideInternalApiConfig(
   val annotatedWith: List<String>
 )
 
 class HideInternalApiTransformer(context: DokkaContext) : SuppressedByConditionDocumentableFilterTransformer(context) {
 
-  private val configuration by lazy {
+  /**
+   * Decode [HideInternalApiPlugin] from the [DokkaContext].
+   */
+  private val configuration: HideInternalApiPlugin by lazy {
     val pluginConfig = context.configuration.pluginsConfiguration
       .firstOrNull { it.fqPluginName == HideInternalApiPlugin.FQN }
 
     if (pluginConfig != null) {
       require(pluginConfig.serializationFormat == DokkaConfiguration.SerializationFormat.JSON) {
-        "HideInternalApiPlugin requires configuration is encoded as JSON"
+        "HideInternalApiPlugin configuration must be encoded as JSON"
       }
 
       Json.decodeFromString(HideInternalApiConfig.serializer(), pluginConfig.values)

diff --git a/...rnal-api/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin b/...rnal-api/src/main/resources/META-INF/services/org.jetbrains.dokka.plugability.DokkaPlugin
@@ -1 +1 @@
-demo.dokka.plugin.ogp.HideInternalApiPlugin
+demo.dokka.plugin.HideInternalApiPlugin
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		demo.dokka.plugin.ogp.HideInternalApiPlugin
		demo.dokka.plugin.HideInternalApiPlugin