From: Julien Lancelot <julien.lancelot@sonarsource.com>
Date: Tue, 28 Apr 2015 10:03:51 +0000 (+0200)
Subject: SONAR-6338 Add some docs in the coverage batch report
X-Git-Tag: 5.2-RC1~2100
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=9595b009028629fc1a16ba833151a816d4456d70;p=sonarqube.git

SONAR-6338 Add some docs in the coverage batch report
---

diff --git a/sonar-batch-protocol/src/main/protobuf/batch_report.proto b/sonar-batch-protocol/src/main/protobuf/batch_report.proto
index 634286f7dd0..a94b9d6a953 100644
--- a/sonar-batch-protocol/src/main/protobuf/batch_report.proto
+++ b/sonar-batch-protocol/src/main/protobuf/batch_report.proto
@@ -211,17 +211,22 @@ message Symbols {
   }
 }
 
-// Only FILE component has coverage information
+// Only FILE component has coverage information, and only executable lines should contains this information.
 // TODO rename it LineCoverage ?
 message Coverage {
   optional int32 line = 1;
 
-  // Number of conditions to cover (never 0)
+  // Number of conditions to cover (if set, the value must be greater than 0)
   optional int32 conditions = 2;
+  // Is the line has been touched by a unit test ? Returning false means that no test has touched this executable line.
   optional bool ut_hits = 3;
+  // Is the line has been touched by a integration test ? Returning false means that no test has touched this executable line.
   optional bool it_hits = 4;
+  // Number of conditions covered by unit tests
   optional int32 ut_covered_conditions = 5;
+  // Number of conditions covered by integration tests
   optional int32 it_covered_conditions = 6;
+  // Number of conditions covered by overall tests
   optional int32 overall_covered_conditions = 7;
 }