attempt at documenting vcc format

jenkinsci · Aug 3, 2023 · 1ae14ee · 1ae14ee
1 parent 1129c8e
commit 1ae14ee
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/src/main/java/com/vectorcast/plugins/vectorcastcoverage/CoverageReport.java b/src/main/java/com/vectorcast/plugins/vectorcastcoverage/CoverageReport.java
@@ -16,6 +16,9 @@
  * @author Kohsuke Kawaguchi
  */
 public final class CoverageReport extends AggregatedReport<CoverageReport/*dummy*/,CoverageReport,EnvironmentReport> {
+
+    private static final Logger logger = Logger.getLogger(CoverageReport.class.getName());
+
     private final VectorCASTBuildAction action;
 
     private CoverageReport(VectorCASTBuildAction action) {

diff --git a/vectorcast-coverage-03.dtd b/vectorcast-coverage-03.dtd
@@ -0,0 +1,37 @@
+<!-- Portions (C) International Organization for Standardization 1986:
+     Permission to copy in any form is granted for use with
+     conforming SGML systems and applications as defined in
+     ISO 8879, provided this notice is included in all copies.
+-->
+
+    <!ELEMENT report (version,stats,data)>
+    <!ELEMENT version>
+    <!ATTLIST value                 CDATA #REQUIRED>
+    <!ELEMENT stats (environments,unit,subprogram)>
+    <!ELEMENT environments>
+    <!ATTLIST value             CDATA #REQUIRED>
+    <!ELEMENT unit>
+    <!ATTLIST value             CDATA #REQUIRED>
+    <!ELEMENT subprogram>
+    <!ATTLIST value             CDATA #REQUIRED>
+    <!ELEMENT data>
+    <!ELEMENT all (coverage*, environment*)>
+    <!ATTLIST name                  CDATA #REQUIRED>
+    <!ELEMENT coverage>
+    <!ATTLIST coverage type     (#PCDATA) #REQUIRED>
+    <!ATTLIST coverage value    (#PCDATA) #REQUIRED>
+    <!ELEMENT environment (coverage*, unit*)>
+    <!ATTLIST name              CDATA #REQUIRED>
+    <!ELEMENT coverage>
+    <!ATTLIST coverage type     (#PCDATA) #REQUIRED>
+    <!ATTLIST coverage value    (#PCDATA) #REQUIRED>
+    <!ELEMENT unit (coverage*, subprogram*)>
+    <!ATTLIST name              CDATA #REQUIRED>
+    <!ELEMENT coverage>
+    <!ATTLIST coverage type     (#PCDATA) #REQUIRED>
+    <!ATTLIST coverage value    (#PCDATA) #REQUIRED>
+    <!ELEMENT subprogram (coverage*)>
+    <!ATTLIST name              CDATA #REQUIRED>
+    <!ELEMENT coverage>
+    <!ATTLIST coverage type     (#PCDATA) #REQUIRED>
+    <!ATTLIST coverage value    (#PCDATA) #REQUIRED>