docs(scanner): Fix docs for ScannerWrapper.matcher

Fix the docs to use the correct paths for the properties that define the matching criteria. While at it, also apply some other minor improvements. Signed-off-by: Martin Nonnenmacher <[email protected]>
oss-review-toolkit · Oct 8, 2023 · 0753d09 · 0753d09
1 parent 1b87f32
commit 0753d09
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/scanner/src/main/kotlin/ScannerWrapper.kt b/scanner/src/main/kotlin/ScannerWrapper.kt
@@ -66,12 +66,12 @@ sealed interface ScannerWrapper {
     /**
      * The [ScannerMatcher] object to be used when looking up existing scan results from a scan storage. By default,
      * the properties of this object are initialized by the scanner implementation. These defaults can be overridden
-     * with the [ScannerConfiguration.options] property: Use properties of the form _scannerName.criteria.property_,
-     * where _scannerName_ is the name of the scanner and _property_ is the name of a property of the [ScannerMatcher]
+     * with the [ScannerConfiguration.options] property: Use properties of the form `scannerName.property`, where
+     * `scannerName` is the name of the scanner and `property` is the name of a property of the [ScannerMatcher]
      * class. For instance, to specify that a specific minimum version of ScanCode is allowed, set this property:
-     * `options.ScanCode.criteria.minScannerVersion=3.0.2`.
+     * `options.ScanCode.minScannerVersion=3.0.2`.
      *
-     * If this property is null it means that the results of this [ScannerWrapper] cannot be stored in a scan storage.
+     * If this property is null, it means that the results of this [ScannerWrapper] cannot be stored in a scan storage.
      */
     val matcher: ScannerMatcher?