Skip to content

Commit

Permalink
docs(spdx-utils): Refer to SpdxSimpleLicenseMapping in normalize()
Browse files Browse the repository at this point in the history
While at it, also mention `isValid` in addition to `validate`.

Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
  • Loading branch information
sschuberth committed Jun 18, 2024
1 parent d477384 commit fce6a94
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions utils/spdx/src/main/kotlin/SpdxExpression.kt
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,9 @@ sealed class SpdxExpression {
}

/**
* Normalize all license IDs using a mapping containing common misspellings of license IDs. If [mapDeprecated] is
* `true`, also deprecated IDs are mapped to their current counterparts. The result of this function is not
* guaranteed to contain only valid IDs. Use [validate] to check the returned [SpdxExpression] for validity
* afterwards.
* Normalize all license IDs using [SpdxSimpleLicenseMapping]. If [mapDeprecated] is `true`, also deprecated IDs are
* mapped to their current counterparts. The result of this function is not guaranteed to contain only valid IDs.
* Use [validate] or [isValid] to check the returned [SpdxExpression] for validity afterwards.
*/
abstract fun normalize(mapDeprecated: Boolean = true): SpdxExpression

Expand Down

0 comments on commit fce6a94

Please sign in to comment.