From ed751085e04453416b384fbe4cb1d36b14665484 Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Wed, 20 Mar 2024 19:14:48 +0100 Subject: [PATCH] docs(model): Improve `PathExclude` class documentation Clarify that also directories can be matched / excluded, and refer to `FileMatcher` for the actual implementation. Signed-off-by: Sebastian Schuberth --- model/src/main/kotlin/config/PathExclude.kt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/model/src/main/kotlin/config/PathExclude.kt b/model/src/main/kotlin/config/PathExclude.kt index 9ca9bfbb51f4f..52b0f6692be50 100644 --- a/model/src/main/kotlin/config/PathExclude.kt +++ b/model/src/main/kotlin/config/PathExclude.kt @@ -24,9 +24,9 @@ import com.fasterxml.jackson.annotation.JsonInclude import org.ossreviewtoolkit.utils.common.FileMatcher /** - * Defines paths which should be excluded. Each file that is matched by the [glob][pattern] is marked as excluded. If a - * project definition file is matched by the [pattern] the whole project is excluded. For details about the glob syntax - * see the [official documentation](https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob). + * Defines paths which should be excluded. Each file or directory that is matched by the [glob][pattern] is marked as + * excluded. If a project definition file is matched by the [pattern], the whole project is excluded. For details about + * the glob syntax see the [FileMatcher] implementation. */ data class PathExclude( /**