LocalScanner: Document the getResult() and generateSummary() functions

Signed-off-by: Sebastian Schuberth <sschuberth@gmail.com>
oss-review-toolkit · May 20, 2019 · a640843 · a640843
1 parent 382325d
commit a640843
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/scanner/src/main/kotlin/LocalScanner.kt b/scanner/src/main/kotlin/LocalScanner.kt
@@ -379,7 +379,13 @@ abstract class LocalScanner(name: String, config: ScannerConfiguration) : Scanne
      */
     abstract fun scanPath(path: File, resultsFile: File): ScanResult
 
+    /**
+     * Return the scanner's raw result in a JSON representation.
+     */
     internal abstract fun getResult(resultsFile: File): JsonNode
 
+    /**
+     * Generate a [ScanSummary] from the scanner's raw [result] and the scan [startTime] / [endTime].
+     */
     internal abstract fun generateSummary(startTime: Instant, endTime: Instant, result: JsonNode): ScanSummary
 }