blob: 486bb80ebf35aaa5df42fade55d050fa80fbb92d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
package org.jetbrains.dokka.dokkatoo.dokka.plugins
import org.jetbrains.dokka.dokkatoo.internal.DokkatooInternalApi
import java.io.Serializable
import javax.inject.Inject
import org.gradle.api.Named
import org.gradle.api.tasks.Input
/**
* Base class for defining Dokka Plugin configuration.
*
* This class should not be instantiated directly. Instead, use a subclass, or create plugin
* parameters dynamically using [DokkaPluginParametersBuilder].
*
* [More information about Dokka Plugins is available in the Dokka docs.](https://kotlinlang.org/docs/dokka-plugins.html)
*
* @param[pluginFqn] Fully qualified classname of the Dokka Plugin
*/
abstract class DokkaPluginParametersBaseSpec
@DokkatooInternalApi
@Inject
constructor(
private val name: String,
@get:Input
open val pluginFqn: String,
) : Serializable, Named {
abstract fun jsonEncode(): String // to be implemented by subclasses
@Input
override fun getName(): String = name
}
|
