From cf6fbb24e585129158a608fcb7db107939725298 Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Wed, 14 Feb 2024 16:46:06 +0100 Subject: [PATCH] docs(model): Improve `ResolvedLicense` docs Signed-off-by: Sebastian Schuberth --- model/src/main/kotlin/licenses/ResolvedLicense.kt | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/model/src/main/kotlin/licenses/ResolvedLicense.kt b/model/src/main/kotlin/licenses/ResolvedLicense.kt index e24d5d2422a2c..e3d653edad5ef 100644 --- a/model/src/main/kotlin/licenses/ResolvedLicense.kt +++ b/model/src/main/kotlin/licenses/ResolvedLicense.kt @@ -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, /** - * The original SPDX expressions of this license. + * The original SPDX expressions that contains the [license]. */ val originalExpressions: Set,