Skip to content

Commit 390b97f

Browse files
committed
docs(CopyrightGarbage): Document the class and property
Signed-off-by: Sebastian Schuberth <[email protected]>
1 parent 31a49fa commit 390b97f

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ package org.ossreviewtoolkit.model.config
2121

2222
import java.util.SortedSet
2323

24-
data class CopyrightGarbage(val items: SortedSet<String> = sortedSetOf())
24+
/**
25+
* A class that defines which Copyright statements are to be considered as garbage instead of real findings.
26+
*/
27+
data class CopyrightGarbage(
28+
/**
29+
* A set of literal strings that identify garbage Copyright findings.
30+
*/
31+
val items: SortedSet<String> = sortedSetOf()
32+
)
2533

2634
fun CopyrightGarbage?.orEmpty(): CopyrightGarbage = this ?: CopyrightGarbage()

0 commit comments

Comments
 (0)