add code documentation and fix code formatting

ljmf00 · ljmf00 · commit b4a0669e3778 · 2019-09-24T16:01:27.000+01:00
- docs: add code documentation
- codestyle: fix formatting

Signed-off-by: Luís Ferreira &lt;contact@lsferreira.net&gt;
diff --git a/src/Models/DotCover/ClassCoverage.cs b/src/Models/DotCover/ClassCoverage.cs
@@ -4,10 +4,26 @@
 
 namespace Codacy.CSharpCoverage.Models.DotCover
 {
+    /// <summary>
+    ///     Class coverage.
+    ///     This represents a class coverage parsed from
+    ///     DotCover format.
+    /// </summary>
     public sealed class ClassCoverage
     {
+        /// <summary>
+        ///     Parsed coverage percentage
+        /// </summary>
         public double CoveragePercent { get; set; }
+
+        /// <summary>
+        ///     Parsed file id
+        /// </summary>
         public int FileId { get; set; }
+
+        /// <summary>
+        ///     Covered lines for the referred file id.
+        /// </summary>
         public List<LineCoverage> CoveredLines { get; set; }
 
         public override bool Equals(object obj)
diff --git a/src/Models/DotCover/LineCoverage.cs b/src/Models/DotCover/LineCoverage.cs
@@ -1,9 +1,25 @@
 namespace Codacy.CSharpCoverage.Models.DotCover
 {
+    /// <summary>
+    ///     Line Coverage.
+    ///     This represents a line coverage parsed from
+    ///     DotCover format.
+    /// </summary>
     public sealed class LineCoverage
     {
+        /// <summary>
+        ///     Parsed start line number
+        /// </summary>
         public int Line { get; set; }
+
+        /// <summary>
+        ///     Parsed end line number
+        /// </summary>
         public int EndLine { get; set; }
+
+        /// <summary>
+        ///     Parsed boolean of the coverage hit.
+        /// </summary>
         public bool Covered { get; set; }
 
         public override bool Equals(object obj)
diff --git a/src/Models/DotCover/Report.cs b/src/Models/DotCover/Report.cs
@@ -3,9 +3,19 @@
 
 namespace Codacy.CSharpCoverage.Models.DotCover
 {
+    /// <summary>
+    ///     Report model based on DotCover file format.
+    /// </summary>
     public sealed class Report : IReport
     {
+        /// <summary>
+        ///     List of class coverages for each file id.
+        /// </summary>
         public List<ClassCoverage> ClassCoverages { get; set; }
+
+        /// <summary>
+        ///     Dictionary of file ids and file paths.
+        /// </summary>
         public Dictionary<int, string> FilesList { get; set; }
 
         public override bool Equals(object obj)
diff --git a/src/Models/IReport.cs b/src/Models/IReport.cs
@@ -1,5 +1,9 @@
 namespace Codacy.CSharpCoverage.Models
 {
+    /// <summary>
+    ///     Report interface.
+    ///     This implements a report format model.
+    /// </summary>
     public interface IReport
     {
     }
diff --git a/src/Models/OpenCover/ClassCoverage.cs b/src/Models/OpenCover/ClassCoverage.cs
@@ -4,10 +4,26 @@
 
 namespace Codacy.CSharpCoverage.Models.OpenCover
 {
+    /// <summary>
+    ///     Class coverage.
+    ///     This contains, for each file id, the class coverage
+    ///     parsed from the OpenCover format.
+    /// </summary>
     public sealed class ClassCoverage
     {
+        /// <summary>
+        ///     Parsed sequence coverage (in percentage)
+        /// </summary>
         public double SequenceCoverage { get; set; }
+
+        /// <summary>
+        ///     Parsed file id.
+        /// </summary>
         public int FileId { get; set; }
+
+        /// <summary>
+        ///     List of covered lines of the referred file id.
+        /// </summary>
         public List<LineCoverage> CoveredLines { get; set; }
 
         public override bool Equals(object obj)
diff --git a/src/Models/OpenCover/LineCoverage.cs b/src/Models/OpenCover/LineCoverage.cs
@@ -1,8 +1,20 @@
 namespace Codacy.CSharpCoverage.Models.OpenCover
 {
+    /// <summary>
+    ///     Line coverage.
+    ///     This contains the line number and the visit count of that line
+    ///     in terms of coverage. This is based OpenCover file format.
+    /// </summary>
     public sealed class LineCoverage
     {
+        /// <summary>
+        ///     Parsed line number
+        /// </summary>
         public int LineNumber { get; set; }
+
+        /// <summary>
+        ///     Parsed coverage visit count
+        /// </summary>
         public int VisitCount { get; set; }
 
         public override bool Equals(object obj)
diff --git a/src/Models/OpenCover/ModuleElement.cs b/src/Models/OpenCover/ModuleElement.cs
@@ -3,9 +3,22 @@
 
 namespace Codacy.CSharpCoverage.Models.OpenCover
 {
+    /// <summary>
+    ///     Module element.
+    ///     This contains Module elements parsed from OpenCover format.
+    ///     This has a dictionary of file ids and file paths. It also has
+    ///     a list of class coverages for each file id.
+    /// </summary>
     public sealed class ModuleElement
     {
+        /// <summary>
+        ///     Dictionary of file ids and file paths.
+        /// </summary>
         public Dictionary<int, string> FilesList { get; set; }
+
+        /// <summary>
+        ///     List of class coverages for each file id.
+        /// </summary>
         public List<ClassCoverage> ClassCoverages { get; set; }
 
         public override bool Equals(object obj)
diff --git a/src/Models/OpenCover/Report.cs b/src/Models/OpenCover/Report.cs
@@ -3,8 +3,14 @@
 
 namespace Codacy.CSharpCoverage.Models.OpenCover
 {
+    /// <summary>
+    ///     Report model based on OpenCover file format.
+    /// </summary>
     public sealed class Report : IReport
     {
+        /// <summary>
+        ///     List of module elements
+        /// </summary>
         public List<ModuleElement> ModuleElements { get; set; }
 
         public override bool Equals(object obj)
diff --git a/src/Models/Result/CodacyReport.cs b/src/Models/Result/CodacyReport.cs
@@ -1,30 +1,50 @@
 using System;
 using System.Collections.Generic;
-using System.IO;
 using System.Linq;
 using System.Text;
 using Newtonsoft.Json;
 
 namespace Codacy.CSharpCoverage.Models.Result
 {
+    /// <summary>
+    ///     Codacy report model.
+    ///     This represents the codacy report format.
+    /// </summary>
     public class CodacyReport
     {
+        /// <summary>
+        ///     File reports constructor.
+        ///     This construct a codacy report using a list of
+        ///     file reports.
+        /// </summary>
+        /// <param name="fileReports">list of file reports</param>
         public CodacyReport(IEnumerable<FileInfo> fileReports)
         {
             var totalTuple = fileReports
                 .Select(f => (Covered: f.Coverage.Count(l => l.Value > 0), Total: f.Coverage.Count))
                 .Aggregate((Covered: 0, Total: 0),
                     (t, n) => t = (Covered: t.Covered + n.Covered, Total: t.Total + n.Total));
 
-            Total = Convert.ToInt32(Math.Round(((double) totalTuple.Covered / totalTuple.Total * 100)));
+            Total = Convert.ToInt32(Math.Round((double) totalTuple.Covered / totalTuple.Total * 100));
             FileReports = fileReports;
         }
 
-        [JsonProperty(PropertyName = "total")] public int Total { get; set; }
+        /// <summary>
+        ///     Total of coverage (in percentage)
+        /// </summary>
+        [JsonProperty(PropertyName = "total")]
+        public int Total { get; set; }
 
+        /// <summary>
+        ///     List of file reports
+        /// </summary>
         [JsonProperty(PropertyName = "fileReports")]
         public IEnumerable<FileInfo> FileReports { get; set; }
 
+        /// <summary>
+        ///     Convert to a string-based json format.
+        /// </summary>
+        /// <returns>string-based json format</returns>
         public override string ToString()
         {
             return JsonConvert.SerializeObject(this,
@@ -35,12 +55,18 @@ public override string ToString()
                 });
         }
 
+        /// <summary>
+        ///     Get a pretty summary of this coverage report file.
+        /// </summary>
+        /// <returns>stats summary</returns>
         public string GetStats()
         {
             var stringBuilder = new StringBuilder($"Coverage report:{Environment.NewLine}{Environment.NewLine}");
 
             foreach (var file in FileReports)
+            {
                 stringBuilder.Append($" {file.Total} %\t{file.Filename}{Environment.NewLine}");
+            }
 
             stringBuilder.Append($"{Environment.NewLine}Total Coverage: {Total}%");
 
diff --git a/src/Models/Result/FileInfo.cs b/src/Models/Result/FileInfo.cs
@@ -4,13 +4,28 @@
 
 namespace Codacy.CSharpCoverage.Models.Result
 {
+    /// <summary>
+    ///     File info.
+    ///     This represents the coverage information of
+    ///     a single file.
+    /// </summary>
     public class FileInfo
     {
+        /// <summary>
+        ///     File name
+        /// </summary>
         [JsonProperty(PropertyName = "filename")]
         public string Filename { get; set; }
 
-        [JsonProperty(PropertyName = "total")] public int Total { get; set; }
+        /// <summary>
+        ///     Total of coverage (in percentage)
+        /// </summary>
+        [JsonProperty(PropertyName = "total")]
+        public int Total { get; set; }
 
+        /// <summary>
+        ///     Dictionary of file line and coverage hits.
+        /// </summary>
         [JsonProperty(PropertyName = "coverage")]
         public Dictionary<int, int> Coverage { get; set; }
 
diff --git a/src/Parsing/IParser.cs b/src/Parsing/IParser.cs
@@ -2,8 +2,21 @@
 
 namespace Codacy.CSharpCoverage.Parsing
 {
+    /// <summary>
+    ///     Parser interface.
+    ///     This implements a parse function to parse the
+    ///     report file.
+    /// </summary>
+    /// <typeparam name="T">report model type</typeparam>
     public interface IParser<out T> where T : IReport
     {
+        /// <summary>
+        ///     Parse.
+        ///     This parse a report file into the report
+        ///     model.
+        /// </summary>
+        /// <param name="file">report file</param>
+        /// <returns>report model</returns>
         T Parse(string file);
     }
 }
diff --git a/src/Parsing/IProcessor.cs b/src/Parsing/IProcessor.cs
@@ -2,6 +2,11 @@
 
 namespace Codacy.CSharpCoverage.Parsing
 {
+    /// <summary>
+    ///     Processor interface.
+    ///     This implements a Transformer and a Parser.
+    /// </summary>
+    /// <typeparam name="T">report model type</typeparam>
     public interface IProcessor<T> : ITransformer<T>, IParser<T> where T : IReport
     {
     }
diff --git a/src/Parsing/ITransformer.cs b/src/Parsing/ITransformer.cs
@@ -3,8 +3,20 @@
 
 namespace Codacy.CSharpCoverage.Parsing
 {
+    /// <summary>
+    ///     Transformer interface.
+    ///     This implements a tranform function, to convert a report into
+    ///     codacy report.
+    /// </summary>
+    /// <typeparam name="T">report model type</typeparam>
     public interface ITransformer<in T> where T : IReport
     {
+        /// <summary>
+        ///     Transform.
+        ///     This transform a T report, into codacy report format.
+        /// </summary>
+        /// <param name="report">report</param>
+        /// <returns>codacy report</returns>
         CodacyReport Transform(T report);
     }
 }
diff --git a/src/Parsing/Processors/DotCoverProcessor.cs b/src/Parsing/Processors/DotCoverProcessor.cs
@@ -7,6 +7,10 @@
 
 namespace Codacy.CSharpCoverage.Parsing.Processors
 {
+    /// <summary>
+    ///     DotCover Processor.
+    ///     This process the DotCover format into Codacy format.
+    /// </summary>
     public class DotCoverProcessor : IProcessor<Report>
     {
         public Report Parse(string file)
@@ -36,7 +40,10 @@ public Report Parse(string file)
                     int? fileId = null;
                     var methodCoverage = new List<LineCoverage>();
                     var methods = projectClass.Elements("Member");
-                    if (!methods.Any()) methods = projectClass.Elements("Method");
+                    if (!methods.Any())
+                    {
+                        methods = projectClass.Elements("Method");
+                    }
 
                     foreach (var method in methods)
                     {
@@ -45,12 +52,14 @@ public Report Parse(string file)
                         {
                             fileId = Convert.ToInt32(lines.First().Attribute("FileIndex").Value);
                             foreach (var line in lines)
+                            {
                                 methodCoverage.Add(new LineCoverage
                                 {
                                     Line = int.Parse(line.Attribute("Line").Value),
                                     EndLine = int.Parse(line.Attribute("EndLine").Value),
                                     Covered = line.Attribute("Covered").Value == "True"
                                 });
+                            }
                         }
 
                         if (fileId != null && report.FilesList.ContainsKey(fileId.Value))
@@ -96,6 +105,13 @@ public CodacyReport Transform(Report report)
             return coverageReport;
         }
 
+        /// <summary>
+        ///     Get the project files list.
+        ///     This function maps a XElement into a KeyValuePair. It has
+        ///     a unique file id and a file path for that id.
+        /// </summary>
+        /// <param name="files">list of files in XElement format</param>
+        /// <returns>dictionary of file id and file path</returns>
         private static Dictionary<int, string> GetProjectFilesList(IEnumerable<XElement> files)
         {
             var fileList = new Dictionary<int, string>();
diff --git a/src/Parsing/Processors/OpenCoverProcessor.cs b/src/Parsing/Processors/OpenCoverProcessor.cs
diff --git a/src/Program.cs b/src/Program.cs

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,9 @@`
`1`	`1`	`namespace Codacy.CSharpCoverage.Models`
`2`	`2`	`{`
	`3`	`+ /// <summary>`
	`4`	`+ /// Report interface.`
	`5`	`+ /// This implements a report format model.`
	`6`	`+ /// </summary>`
`3`	`7`	`public interface IReport`
`4`	`8`	`{`
`5`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,14 @@`
`3`	`3`
`4`	`4`	`namespace Codacy.CSharpCoverage.Models.OpenCover`
`5`	`5`	`{`
	`6`	`+ /// <summary>`
	`7`	`+ /// Report model based on OpenCover file format.`
	`8`	`+ /// </summary>`
`6`	`9`	`public sealed class Report : IReport`
`7`	`10`	`{`
	`11`	`+ /// <summary>`
	`12`	`+ /// List of module elements`
	`13`	`+ /// </summary>`
`8`	`14`	`public List<ModuleElement> ModuleElements { get; set; }`
`9`	`15`
`10`	`16`	`public override bool Equals(object obj)`