Skip to content

Commit

Permalink
docs(plugins-api): Fix docs for PluginDescriptor properties
Browse files Browse the repository at this point in the history
It is the `className` that must be unique, not the `displayName`.

Signed-off-by: Martin Nonnenmacher <martin.nonnenmacher@bosch.com>
  • Loading branch information
mnonnenmacher committed Sep 2, 2024
1 parent 9b13596 commit 4da006b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions plugins/api/src/main/kotlin/PluginDescriptor.kt
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ package org.ossreviewtoolkit.plugins.api
*/
data class PluginDescriptor(
/**
* The display name of the plugin. Must be unique among all plugins for the same factory class.
* The display name of the plugin.
*/
val displayName: String,

/**
* The name of the plugin class.
* The name of the plugin class. Must be unique among all plugins for the same factory class.
*/
val className: String,

Expand Down

0 comments on commit 4da006b

Please sign in to comment.