Skip to content

Commit

Permalink
docs(model): Improve ResolvedLicense docs
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Schuberth <[email protected]>
  • Loading branch information
sschuberth committed Feb 14, 2024
1 parent 18fa677 commit cf6fbb2
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions model/src/main/kotlin/licenses/ResolvedLicense.kt
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,23 @@ import org.ossreviewtoolkit.utils.ort.DeclaredLicenseProcessor
import org.ossreviewtoolkit.utils.spdx.SpdxSingleLicenseExpression

/**
* Resolved information for a single license.
* Resolved information for a single [license], documenting the [sources] and original license expressions it is
* contained in.
*/
data class ResolvedLicense(
/**
* The license.
* The license for which original license [sources] are documented.
*/
val license: SpdxSingleLicenseExpression,

/**
* The set of original declared license that were [processed][DeclaredLicenseProcessor] to this [license], or an
* empty list, if this [license] was not modified during processing.
* The set of original declared license that were [processed][DeclaredLicenseProcessor] to the [license], or an
* empty list if this [license] was not modified during processing.
*/
val originalDeclaredLicenses: Set<String>,

/**
* The original SPDX expressions of this license.
* The original SPDX expressions that contains the [license].
*/
val originalExpressions: Set<ResolvedOriginalExpression>,

Expand Down

0 comments on commit cf6fbb2

Please sign in to comment.