Skip to content

Commit 77d8804

Browse files
committed
docs(plugins): Align documentation for the ALL properties
Signed-off-by: Sebastian Schuberth <[email protected]>
1 parent b76b7a7 commit 77d8804

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

plugins/commands/api/src/main/kotlin/OrtCommand.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import org.ossreviewtoolkit.utils.ort.ORT_CONFIG_FILENAME
3535
abstract class OrtCommand(name: String, help: String) : CliktCommand(name = name, help = help), Plugin {
3636
companion object {
3737
/**
38-
* All ORT commands available in the classpath, associated by their names.
38+
* All [ORT commands][OrtCommand] available in the classpath, associated by their names.
3939
*/
4040
val ALL by lazy { Plugin.getAll<OrtCommand>() }
4141
}

plugins/package-configuration-providers/api/src/main/kotlin/PackageConfigurationProviderFactory.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ import org.ossreviewtoolkit.utils.common.getDuplicates
3333
interface PackageConfigurationProviderFactory<CONFIG> :
3434
TypedConfigurablePluginFactory<CONFIG, PackageConfigurationProvider> {
3535
companion object {
36+
/**
37+
* All [package configuration provider factories][PackageConfigurationProviderFactory] available in the
38+
* classpath, associated by their names.
39+
*/
3640
val ALL by lazy { Plugin.getAll<PackageConfigurationProviderFactory<*>>() }
3741

3842
/**

plugins/package-curation-providers/api/src/main/kotlin/PackageCurationProviderFactory.kt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ import org.ossreviewtoolkit.utils.common.getDuplicates
3333
*/
3434
interface PackageCurationProviderFactory<CONFIG> : TypedConfigurablePluginFactory<CONFIG, PackageCurationProvider> {
3535
companion object {
36+
/**
37+
* All [package curation provider factories][PackageCurationProviderFactory] available in the classpath,
38+
* associated by their names.
39+
*/
3640
val ALL by lazy { Plugin.getAll<PackageCurationProviderFactory<*>>() }
3741

3842
/**

0 commit comments

Comments
 (0)