docs(plugins): Trivially improve the plugin docs

mnonnenmacher · mnonnenmacher · commit 8a841854c716 · 2026-06-03T11:39:40.000+02:00
Apply some trivial improvements to ensure that the plugins docs are
rendered nicely on the website. This mainly consists of fixing links.

Signed-off-by: Martin Nonnenmacher &lt;martin.nonnenmacher@doubleopen.io&gt;
diff --git a/plugins/advisors/black-duck/src/main/kotlin/BlackDuck.kt b/plugins/advisors/black-duck/src/main/kotlin/BlackDuck.kt
@@ -52,8 +52,8 @@ import org.ossreviewtoolkit.utils.common.collectMessages
 
 /**
  * This advice provider by default retrieves vulnerabilities by the purl corresponding to the package. If a package has
- * the label [BlackDuck.PACKAGE_LABEL_BLACK_DUCK_ORIGIN_ID] set, then the vulnerabilities are retrieved by that
- * origin-id instead of by the purl.
+ * the label ["black-duck:origin-id"][BlackDuck.PACKAGE_LABEL_BLACK_DUCK_ORIGIN_ID] set, then the vulnerabilities are
+ * retrieved by that origin-id instead of by the purl.
  */
 @OrtPlugin(
     displayName = "Black Duck",
diff --git a/plugins/advisors/osv/src/main/kotlin/Osv.kt b/plugins/advisors/osv/src/main/kotlin/Osv.kt
@@ -44,7 +44,7 @@ import org.ossreviewtoolkit.utils.common.toUri
 import org.ossreviewtoolkit.utils.ort.OkHttpClientHelper
 
 /**
- * An advice provider that obtains vulnerability information from Open Source Vulnerabilities (https://osv.dev/).
+ * An advice provider that obtains vulnerability information from [Open Source Vulnerabilities](https://osv.dev/).
  */
 @OrtPlugin(
     id = "OSV",
diff --git a/plugins/advisors/scanoss/src/main/kotlin/ScanOss.kt b/plugins/advisors/scanoss/src/main/kotlin/ScanOss.kt
@@ -53,7 +53,7 @@ import org.ossreviewtoolkit.utils.ort.okHttpClient
 
 /**
  * An [AdviceProvider] implementation that obtains security vulnerability information from a
- * [SCANOSS][https://github.com/aboutcode-org/vulnerablecode] instance.
+ * [SCANOSS](https://github.com/aboutcode-org/vulnerablecode) instance.
  */
 @OrtPlugin(
     displayName = "SCANOSS",
diff --git a/plugins/advisors/vulnerable-code/src/main/kotlin/VulnerableCode.kt b/plugins/advisors/vulnerable-code/src/main/kotlin/VulnerableCode.kt
@@ -62,7 +62,7 @@ private const val MAX_SUMMARY_LENGTH = 64
 
 /**
  * An [AdviceProvider] implementation that obtains security vulnerability information from a
- * [VulnerableCode][https://github.com/aboutcode-org/vulnerablecode] instance.
+ * [VulnerableCode](https://github.com/aboutcode-org/vulnerablecode) instance.
  */
 @OrtPlugin(
     displayName = "VulnerableCode",
diff --git a/plugins/license-fact-providers/dir/src/main/kotlin/DirLicenseFactProvider.kt b/plugins/license-fact-providers/dir/src/main/kotlin/DirLicenseFactProvider.kt
@@ -37,6 +37,10 @@ data class DirLicenseFactProviderConfig(
     val licenseTextDir: String
 )
 
+/**
+ * A license fact provider that reads license information from the default directory. The files must be named after the
+ * SPDX-conform license IDs, e.g., 'Apache-2.0' or 'LicenseRef-custom-license'.
+ */
 @OrtPlugin(
     displayName = "Default Directory License Fact Provider",
     summary = "A license fact provider that reads license information from the default directory.",
@@ -50,11 +54,14 @@ class DefaultDirLicenseFactProvider(descriptor: PluginDescriptor = DefaultDirLic
         )
     )
 
+/**
+ * A license fact provider that reads license information from a local directory. The files must be named after the
+ * SPDX-conform license IDs, e.g., 'Apache-2.0' or 'LicenseRef-custom-license'.
+ */
 @OrtPlugin(
     id = "Dir",
     displayName = "Directory License Fact Provider",
-    summary = "A license fact provider that reads license information from a local directory. The files must be " +
-        "named after the SPDX-conform license IDs, e.g., 'Apache-2.0' or 'LicenseRef-custom-license'.",
+    summary = "A license fact provider that reads license information from a local directory.",
     factory = LicenseFactProviderFactory::class
 )
 open class DirLicenseFactProvider(
diff --git a/plugins/package-curation-providers/spring/src/main/kotlin/SpringPackageCurationProvider.kt b/plugins/package-curation-providers/spring/src/main/kotlin/SpringPackageCurationProvider.kt
@@ -29,7 +29,7 @@ import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCuration
 import org.ossreviewtoolkit.plugins.packagecurationproviders.api.PackageCurationProviderFactory
 
 /**
- * A [PackageCurationProvider] that provides [PackageCuration]s for Spring (https://spring.io/) packages.
+ * A [PackageCurationProvider] that provides [PackageCuration]s for [Spring](https://spring.io/) packages.
  */
 @OrtPlugin(
     displayName = "Spring",
diff --git a/plugins/package-managers/bundler/src/main/kotlin/Bundler.kt b/plugins/package-managers/bundler/src/main/kotlin/Bundler.kt
@@ -109,10 +109,8 @@ data class BundlerConfig(
 )
 
 /**
- * The [Bundler][1] package manager for Ruby. Also see [Clarifying the Roles of the .gemspec and Gemfile][2].
- *
- * [1]: https://bundler.io/
- * [2]: http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+ * The [Bundler](https://bundler.io/) package manager for Ruby. Also see [Clarifying the Roles of the .gemspec and
+ * Gemfile](http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/).
  */
 @OrtPlugin(
     displayName = "Bundler",
diff --git a/plugins/package-managers/go/src/main/kotlin/GoMod.kt b/plugins/package-managers/go/src/main/kotlin/GoMod.kt
@@ -86,8 +86,8 @@ data class GoModConfig(
 )
 
 /**
- * The [Go Modules](https://go.dev/ref/mod) package manager for Go. Also see the [usage and troubleshooting guide]
- * (https://github.com/golang/go/wiki/Modules).
+ * The [Go Modules](https://go.dev/ref/mod) package manager for Go. Also see the
+ * [usage and troubleshooting guide](https://github.com/golang/go/wiki/Modules).
  *
  * Note: The file `go.sum` is not a lockfile as Go modules already allows for reproducible builds without that file.
  * Thus, no logic for handling the [AnalyzerConfiguration.allowDynamicVersions] is needed.
diff --git a/plugins/package-managers/python/src/main/kotlin/Poetry.kt b/plugins/package-managers/python/src/main/kotlin/Poetry.kt
@@ -62,7 +62,7 @@ internal object PoetryCommand : CommandLineTool {
 }
 
 /**
- * [Poetry](https://python-poetry.org/) package manager for Python.
+ * The [Poetry](https://python-poetry.org/) package manager for Python.
  */
 @OrtPlugin(
     displayName = "Poetry",
diff --git a/plugins/reporters/asciidoc/src/main/kotlin/DocBookTemplateReporter.kt b/plugins/reporters/asciidoc/src/main/kotlin/DocBookTemplateReporter.kt
@@ -25,10 +25,8 @@ import org.ossreviewtoolkit.reporter.Reporter
 import org.ossreviewtoolkit.reporter.ReporterFactory
 
 /**
- * A [Reporter] that creates [DocBook][1] files from [Apache Freemarker][2] templates.
- *
- * [1]: https://docbook.org
- * [2]: https://freemarker.apache.org
+ * A [Reporter] that creates [DocBook](https://docbook.org) files from
+ * [Apache Freemarker](https://freemarker.apache.org) templates.
  */
 @OrtPlugin(
     displayName = "DocBook Template",
diff --git a/plugins/reporters/asciidoc/src/main/kotlin/HtmlTemplateReporter.kt b/plugins/reporters/asciidoc/src/main/kotlin/HtmlTemplateReporter.kt
@@ -25,9 +25,7 @@ import org.ossreviewtoolkit.reporter.Reporter
 import org.ossreviewtoolkit.reporter.ReporterFactory
 
 /**
- * A [Reporter] that creates HTML files from [Apache Freemarker][1] templates.
- *
- * [1]: https://freemarker.apache.org
+ * A [Reporter] that creates HTML files from [Apache Freemarker](https://freemarker.apache.org) templates.
  */
 @OrtPlugin(
     displayName = "HTML Template",
diff --git a/plugins/reporters/asciidoc/src/main/kotlin/ManPageTemplateReporter.kt b/plugins/reporters/asciidoc/src/main/kotlin/ManPageTemplateReporter.kt
@@ -25,9 +25,7 @@ import org.ossreviewtoolkit.reporter.Reporter
 import org.ossreviewtoolkit.reporter.ReporterFactory
 
 /**
- * A [Reporter] that creates man pages from [Apache Freemarker][1] templates.
- *
- * [1]: https://freemarker.apache.org
+ * A [Reporter] that creates man pages from [Apache Freemarker](https://freemarker.apache.org) templates.
  */
 @OrtPlugin(
     displayName = "Man Page Template",
diff --git a/plugins/reporters/asciidoc/src/main/kotlin/PdfTemplateReporter.kt b/plugins/reporters/asciidoc/src/main/kotlin/PdfTemplateReporter.kt
@@ -58,24 +58,19 @@ data class PdfTemplateReporterConfig(
 )
 
 /**
- * A [Reporter] that creates PDF files using a combination of [Apache Freemarker][1] templates and [AsciiDoc][2]
- * with [AsciidoctorJ][3] as Java interface and [AsciidoctorJ PDF][4] as PDF file generator.
+ * A [Reporter] that creates PDF files using a combination of [Apache Freemarker](https://freemarker.apache.org)
+ * templates and [AsciiDoc](https://asciidoc.org/) with [AsciidoctorJ](https://github.com/asciidoctor/asciidoctorj) as
+ * Java interface and [AsciidoctorJ PDF](https://github.com/asciidoctor/asciidoctorj-pdf) as PDF file generator.
  * For each Freemarker template provided using the options described below, a separate intermediate file is created
  * that can be processed by AsciidoctorJ. If no options are provided, the "disclosure_document" template is used, and if
  * security vulnerability information is available also the "vulnerability_report" template.
  *
  * After the intermediate files are generated, they are processed by AsciidoctorJ PDF.
  * A PDF theme can be handed over to AsciidoctorJ PDF in which properties like fonts or images displayed in the PDF can
- * be adjusted; see the [Theme Guide][5].
+ * be adjusted; see the [Theme Guide](https://docs.asciidoctor.org/pdf-converter/latest/theme/).
  * The path to this theme can be set in the options as described below.
  * Note that only one theme can be set that is used for all given templates. If no theme is given, a default built-in
  * theme of AsciidoctorJ PDF is used.
- *
- * [1]: https://freemarker.apache.org
- * [2]: https://asciidoc.org/
- * [3]: https://github.com/asciidoctor/asciidoctorj
- * [4]: https://github.com/asciidoctor/asciidoctorj-pdf
- * [5]: https://docs.asciidoctor.org/pdf-converter/latest/theme/
  */
 @OrtPlugin(
     displayName = "PDF Template",
diff --git a/plugins/reporters/freemarker/src/main/kotlin/PlainTextTemplateReporter.kt b/plugins/reporters/freemarker/src/main/kotlin/PlainTextTemplateReporter.kt
@@ -52,12 +52,11 @@ data class PlainTextTemplateReporterConfig(
 }
 
 /**
- * A [Reporter] that creates plain text files using [Apache Freemarker][1] templates. For each template provided in the
- * [config], a separate output file is created. If no templates are provided, the "NOTICE_DEFAULT" template is used.
+ * A [Reporter] that creates plain text files using [Apache Freemarker](https://freemarker.apache.org) templates. For
+ * each template provided in the [config], a separate output file is created. If no templates are provided, the
+ * "NOTICE_DEFAULT" template is used.
  * The name of the template id or template path (without extension) is used for the generated file, so be careful to not
  * use two different templates with the same name.
- *
- * [1]: https://freemarker.apache.org
  */
 @OrtPlugin(
     displayName = "Plain Text Template",
diff --git a/plugins/scanners/dos/src/main/kotlin/DosScanner.kt b/plugins/scanners/dos/src/main/kotlin/DosScanner.kt
@@ -59,16 +59,14 @@ import org.ossreviewtoolkit.utils.ort.createOrtTempDir
 import org.ossreviewtoolkit.utils.ort.runBlocking
 
 /**
- * The DOS scanner wrapper is a client for the scanner API implemented as part of the Double Open Server project at
- * https://github.com/doubleopen-project/dos. The server runs ScanCode in the backend and stores / reuses scan results
- * on a per-file basis and thus uses its own scan storage.
+ * The DOS scanner wrapper is a client for the scanner API implemented as part of the
+ * [Double Open Server](https://github.com/doubleopen-project/dos). The server runs ScanCode in the backend and stores /
+ * reuses scan results on a per-file basis and thus uses its own scan storage.
  */
 @OrtPlugin(
     id = "DOS",
     displayName = "Double Open Server",
-    summary = "The DOS scanner wrapper is a client for the scanner API implemented as part of the Double Open " +
-        "Server project at https://github.com/doubleopen-project/dos. The server runs ScanCode in the backend and " +
-        "stores / reuses scan results on a per-file basis and thus uses its own scan storage.",
+    summary = "A wrapper for the [Double Open Server](https://github.com/doubleopen-project/dos).",
     factory = ScannerWrapperFactory::class
 )
 class DosScanner(

Original file line number	Diff line number	Diff line change
`@@ -86,8 +86,8 @@ data class GoModConfig(`
`86`	`86`	`)`
`87`	`87`
`88`	`88`	`/**`
`89`		`- * The [Go Modules](https://go.dev/ref/mod) package manager for Go. Also see the [usage and troubleshooting guide]`
`90`		`- * (https://github.com/golang/go/wiki/Modules).`
	`89`	`+ * The [Go Modules](https://go.dev/ref/mod) package manager for Go. Also see the`
	`90`	`+ * [usage and troubleshooting guide](https://github.com/golang/go/wiki/Modules).`
`91`	`91`	`*`
`92`	`92`	* Note: The file `go.sum` is not a lockfile as Go modules already allows for reproducible builds without that file.
`93`	`93`	`* Thus, no logic for handling the [AnalyzerConfiguration.allowDynamicVersions] is needed.`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ internal object PoetryCommand : CommandLineTool {`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`/**`
`65`		`- * [Poetry](https://python-poetry.org/) package manager for Python.`
	`65`	`+ * The [Poetry](https://python-poetry.org/) package manager for Python.`
`66`	`66`	`*/`
`67`	`67`	`@OrtPlugin(`
`68`	`68`	`displayName = "Poetry",`