Skip to content

Commit

Permalink
docs(model): Improve PathExclude class documentation
Browse files Browse the repository at this point in the history
Clarify that also directories can be matched / excluded, and refer to
`FileMatcher` for the actual implementation.

Signed-off-by: Sebastian Schuberth <[email protected]>
  • Loading branch information
sschuberth committed Mar 20, 2024
1 parent 7c0717f commit ed75108
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions model/src/main/kotlin/config/PathExclude.kt
Original file line number Diff line number Diff line change
Expand Up @@ -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(
/**
Expand Down

0 comments on commit ed75108

Please sign in to comment.