Skip to content

Commit 0aed1b4

Browse files
committed
Reporter: Slightly simplify the interface documentation
The comment mentions `OrtResult` as input, so mentioning `AnalyzerResult` and `ScannerRecord` is a bit redundant. The previous comment was also inconsistent as it didn't mention the stages for the advisor and evaluator. Don't mention the individual stages for simplifying an upcoming change. While at it also drop the second sentence, as it is redundant. Signed-off-by: Frank Viernau <[email protected]>
1 parent eed3ca6 commit 0aed1b4

File tree

1 file changed

+1
-4
lines changed

1 file changed

+1
-4
lines changed

reporter/src/main/kotlin/Reporter.kt

+1-4
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,13 @@ package org.ossreviewtoolkit.reporter
2222
import java.io.File
2323
import java.util.ServiceLoader
2424

25-
import org.ossreviewtoolkit.model.AnalyzerResult
2625
import org.ossreviewtoolkit.model.OrtResult
27-
import org.ossreviewtoolkit.model.ScanRecord
2826
import org.ossreviewtoolkit.model.config.PathExclude
2927
import org.ossreviewtoolkit.model.config.ScopeExclude
3028
import org.ossreviewtoolkit.utils.common.joinNonBlank
3129

3230
/**
33-
* A reporter that creates a human-readable report from the [AnalyzerResult] and [ScanRecord] contained in an
34-
* [OrtResult]. The signatures of public functions in this class define the library API.
31+
* A reporter that creates a human-readable report from a given [OrtResult].
3532
*/
3633
interface Reporter {
3734
companion object {

0 commit comments

Comments
 (0)