Skip to content

Commit 9663709

Browse files
committed
docs(model): Improve PackageConfiguration class docs
Explain the relationship to `RepositoryConfiguration`. Signed-off-by: Sebastian Schuberth <[email protected]>
1 parent 2585bc9 commit 9663709

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

model/src/main/kotlin/config/PackageConfiguration.kt

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ import com.fasterxml.jackson.annotation.JsonInclude
2323

2424
import org.ossreviewtoolkit.model.ArtifactProvenance
2525
import org.ossreviewtoolkit.model.Identifier
26+
import org.ossreviewtoolkit.model.Package
27+
import org.ossreviewtoolkit.model.Project
2628
import org.ossreviewtoolkit.model.Provenance
2729
import org.ossreviewtoolkit.model.RepositoryProvenance
2830
import org.ossreviewtoolkit.model.UnknownProvenance
@@ -31,8 +33,10 @@ import org.ossreviewtoolkit.model.VcsType
3133
import org.ossreviewtoolkit.utils.common.replaceCredentialsInUri
3234

3335
/**
34-
* A configuration for a specific package and provenance. It allows to set up [PathExclude]s and
35-
* [LicenseFindingCuration]s, similar to how it is done via the [RepositoryConfiguration] for projects.
36+
* A classed used in the [OrtConfiguration] to configure [PathExclude]s and [LicenseFindingCuration]s for a specific
37+
* [Package]'s [Identifier] (and [Provenance]).
38+
* Note that [PathExclude]s and [LicenseFindingCuration]s for [Project]s are configured by a [RepositoryConfiguration]'s
39+
* [excludes][RepositoryConfiguration.excludes] and [curations][RepositoryConfiguration.curations] properties instead.
3640
*/
3741
data class PackageConfiguration(
3842
/**

0 commit comments

Comments
 (0)