important comments added

Author: prayascoriolis

core/src/main/java/org/jsmart/zerocode/core/domain/reports/csv/ZeroCodeCsvReport.java

@@ -11,6 +11,7 @@ public class ZeroCodeCsvReport {
     String requestTimeStamp;
     String responseTimeStamp;
     private Double responseDelayMilliSec;
+    // defining meta data fields
     private String metaAuthors;
     private String metaTickets;
     private String metaCategories;
@@ -71,6 +72,8 @@ public String getResponseTimeStamp() {
         return responseTimeStamp;
     }
 
+    // defining meta data field setters and getters
+
     public String getMetaAuthors() {
         return metaAuthors;
     }

core/src/main/java/org/jsmart/zerocode/core/report/ZeroCodeReportGeneratorImpl.java

@@ -99,7 +99,9 @@ public void generateExtentReport() {
             thisReport.getResults().forEach(thisScenario -> {
                 ExtentTest test = extentReports.createTest(thisScenario.getScenarioName());
 
-                // Add meta information to the test
+                 /**This code checks if the scenario has meta data.
+                 If it does, it iterates through each meta data entry and adds it to
+                 the Extent report as an info label.**/
                 if (thisScenario.getMeta() != null) {
                     for (Map.Entry<String, List<String>> entry : thisScenario.getMeta().entrySet()) {
                         String key = entry.getKey();
@@ -286,6 +288,7 @@ public void generateCsvReport(List<ZeroCodeCsvReport> zeroCodeCsvReportRows) {
                 .addColumn("responseTimeStamp")
                 .addColumn("result")
                 .addColumn("method")
+                // This adds new columns to the CSV schema for each type of meta data.
                 .addColumn("metaAuthors")
                 .addColumn("metaTickets")
                 .addColumn("metaCategories")
@@ -327,6 +330,9 @@ public List<ZeroCodeCsvReport> buildCsvRows() {
                     // Add meta information
                     Map<String, List<String>> meta = thisResult.getMeta();
                     if (meta != null) {
+                        /**This code retrieves the meta data from the test result. If meta data exists,
+                         * it joins the list of values for each meta data type into a comma-separated
+                         * string and adds it to the CSV row.**/
                         csvFileBuilder.metaAuthors(String.join(", ", meta.getOrDefault("authors", Collections.emptyList())));
                         csvFileBuilder.metaTickets(String.join(", ", meta.getOrDefault("tickets", Collections.emptyList())));
                         csvFileBuilder.metaCategories(String.join(", ", meta.getOrDefault("categories", Collections.emptyList())));