From 750e4e40b3d6770e78f193302a0717057f026caa Mon Sep 17 00:00:00 2001
From: Sebastian Schuberth <sebastian@doubleopen.org>
Date: Fri, 24 Nov 2023 16:35:27 +0100
Subject: [PATCH] docs(plugins): Align documentation for the `ALL` properties

Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
---
 plugins/commands/api/src/main/kotlin/OrtCommand.kt            | 2 +-
 .../src/main/kotlin/PackageConfigurationProviderFactory.kt    | 4 ++++
 .../api/src/main/kotlin/PackageCurationProviderFactory.kt     | 4 ++++
 3 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/plugins/commands/api/src/main/kotlin/OrtCommand.kt b/plugins/commands/api/src/main/kotlin/OrtCommand.kt
index 750f8c0d203a4..cec72d12f6a54 100644
--- 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/plugins/package-configuration-providers/api/src/main/kotlin/PackageConfigurationProviderFactory.kt b/plugins/package-configuration-providers/api/src/main/kotlin/PackageConfigurationProviderFactory.kt
index 3f68646c62356..f384d8d1bb8de 100644
--- a/plugins/package-configuration-providers/api/src/main/kotlin/PackageConfigurationProviderFactory.kt
+++ b/plugins/package-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
index 44c0afb119dc9..2340deb902eac 100644
--- 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<*>>() }
 
         /**