Skip to content

Commit 0eb0986

Browse files
committed
docs(model): Improve docs for ProviderPluginConfiguration
Signed-off-by: Martin Nonnenmacher <[email protected]>
1 parent 40645ee commit 0eb0986

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

model/src/main/kotlin/config/ProviderPluginConfiguration.kt

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,15 @@ import com.fasterxml.jackson.annotation.JsonIgnore
2323

2424
import com.sksamuel.hoplite.ConfigAlias
2525

26+
import org.ossreviewtoolkit.utils.common.ConfigurablePluginFactory
2627
import org.ossreviewtoolkit.utils.common.Options
2728
import org.ossreviewtoolkit.utils.common.Plugin
2829

2930
/**
30-
* The configuration of provider plugins.
31+
* The configuration of provider [plugins][ConfigurablePluginFactory]. This class is used when multiple instances of the
32+
* same type of plugin should be configurable, like it is for example possible for package curation providers.
33+
* Therefore, each configured plugin gets a unique [id] in addition to the plugin [type] to be able to distinguish
34+
* different configurations for the same plugin type.
3135
*/
3236
data class ProviderPluginConfiguration(
3337
/**

0 commit comments

Comments
 (0)