From da05cf145d0dde48f92bd7222a1640ba2be12479 Mon Sep 17 00:00:00 2001 From: Rd Date: Tue, 13 Aug 2024 20:59:35 +0530 Subject: [PATCH] Updated Kdocs for CoverageReporter with changes to providing proto paths as list.txt file --- .../scripts/coverage/reporter/CoverageReporter.kt | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/scripts/src/java/org/oppia/android/scripts/coverage/reporter/CoverageReporter.kt b/scripts/src/java/org/oppia/android/scripts/coverage/reporter/CoverageReporter.kt index e78db33f125..b27ec9283ce 100644 --- a/scripts/src/java/org/oppia/android/scripts/coverage/reporter/CoverageReporter.kt +++ b/scripts/src/java/org/oppia/android/scripts/coverage/reporter/CoverageReporter.kt @@ -29,12 +29,16 @@ const val BOLD = "\u001B[1m" * * Arguments: * - path_to_root: directory path to the root of the Oppia Android repository. - * - text_file_with_list_of_coverage_data_proto_paths: the text file that contains the list of - * relative path to the proto files with coverage report data to analyse coverage. + * - text_file_with_list_of_coverage_data_proto_paths: the text file that contains + * the list of relative path to the proto files containing coverage report data + * separated by spaces to analyse coverage. + * Sample `coverage_proto_list.txt` content: + * ``` + * coverage_reports/coverage_report1.pb coverage_reports/coverage_report2.pb + * ``` * * Example: - * bazel run //scripts:coverage_reporter -- $(pwd) coverage_reports/utility/src/main/java \\ - * /org/oppia/android/util/parser/math/MathModel/coverage_report.pb + * bazel run //scripts:coverage_reporter -- $(pwd) coverage_proto_list.txt */ fun main(vararg args: String) { val repoRoot = args[0]