docs(plugins): Align documentation for the ALL properties

Signed-off-by: Sebastian Schuberth <[email protected]>
oss-review-toolkit · Nov 24, 2023 · 77d8804 · 77d8804
1 parent b76b7a7
commit 77d8804
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/plugins/commands/api/src/main/kotlin/OrtCommand.kt b/plugins/commands/api/src/main/kotlin/OrtCommand.kt
@@ -35,7 +35,7 @@ import org.ossreviewtoolkit.utils.ort.ORT_CONFIG_FILENAME
 abstract class OrtCommand(name: String, help: String) : CliktCommand(name = name, help = help), Plugin {
     companion object {
         /**
-         * All ORT commands available in the classpath, associated by their names.
+         * All [ORT commands][OrtCommand] available in the classpath, associated by their names.
          */
         val ALL by lazy { Plugin.getAll<OrtCommand>() }
     }

diff --git a/...ackage-configuration-providers/api/src/main/kotlin/PackageConfigurationProviderFactory.kt b/...ackage-configuration-providers/api/src/main/kotlin/PackageConfigurationProviderFactory.kt
@@ -33,6 +33,10 @@ import org.ossreviewtoolkit.utils.common.getDuplicates
 interface PackageConfigurationProviderFactory<CONFIG> :
     TypedConfigurablePluginFactory<CONFIG, PackageConfigurationProvider> {
     companion object {
+        /**
+         * All [package configuration provider factories][PackageConfigurationProviderFactory] available in the
+         * classpath, associated by their names.
+         */
         val ALL by lazy { Plugin.getAll<PackageConfigurationProviderFactory<*>>() }
 
         /**

diff --git a/plugins/package-curation-providers/api/src/main/kotlin/PackageCurationProviderFactory.kt b/plugins/package-curation-providers/api/src/main/kotlin/PackageCurationProviderFactory.kt
@@ -33,6 +33,10 @@ import org.ossreviewtoolkit.utils.common.getDuplicates
  */
 interface PackageCurationProviderFactory<CONFIG> : TypedConfigurablePluginFactory<CONFIG, PackageCurationProvider> {
     companion object {
+        /**
+         * All [package curation provider factories][PackageCurationProviderFactory] available in the classpath,
+         * associated by their names.
+         */
         val ALL by lazy { Plugin.getAll<PackageCurationProviderFactory<*>>() }
 
         /**