Export docs when packing (#2087)

src/.editorconfig

@@ -194,4 +194,12 @@ dotnet_naming_style.pascal_case.capitalization = pascal_case
 dotnet_naming_style.begins_with_i.required_prefix = I
 dotnet_naming_style.begins_with_i.required_suffix = 
 dotnet_naming_style.begins_with_i.word_separator = 
-dotnet_naming_style.begins_with_i.capitalization = pascal_case
+dotnet_naming_style.begins_with_i.capitalization = pascal_case
+
+dotnet_diagnostic.CS1570.severity = warning
+dotnet_diagnostic.CS1572.severity = warning
+dotnet_diagnostic.CS1573.severity = warning
+dotnet_diagnostic.CS1574.severity = warning
+dotnet_diagnostic.CS1591.severity = warning
+dotnet_diagnostic.CS1712.severity = warning
+dotnet_diagnostic.CS1734.severity = warning

src/Sarif/Baseline/ResultMatching/SarifLogResultMatcher.cs

@@ -36,7 +36,7 @@ public SarifLogResultMatcher(
         /// Helper function that accepts a single baseline and current SARIF log and matches them.
         /// </summary>
         /// <param name="previousLog">Array of SARIF logs representing the baseline run</param>
-        /// <param name="currentLogs">Array of SARIF logs representing the current run</param>
+        /// <param name="currentLog">Array of SARIF logs representing the current run</param>
         /// <returns>A SARIF log with the merged set of results.</returns>
         public SarifLog Match(SarifLog previousLog, SarifLog currentLog)
         {

src/Sarif/Baseline/V2/WhatComparer.cs

@@ -71,6 +71,7 @@ public static IEnumerable<WhatComponent> WhatProperties(this ExtractedResult res
         /// <summary>
         ///  Match the 'What' properties of two ExtractedResults.
         /// </summary>
+        /// <param name="left">ExtractedResult to match</param>
         /// <param name="right">ExtractedResult to match</param>
         /// <returns>True if *any* 'What' property matches, False otherwise</returns>
         public static bool MatchesWhat(ExtractedResult left, ExtractedResult right, TrustMap trustMap = null)

src/Sarif/Core/ArtifactLocation.cs

@@ -14,7 +14,6 @@ public partial class ArtifactLocation
         /// successfully reconstitute an absolute URI, it will return false
         /// and populate 'resolvedUri' with null.
         /// </summary>
-        /// <param name="fileLocation">The fileLocatio instance from which an absolute URI should be reconstructed, if possible.</param>
         /// <param name="originalUriBaseIds">The original uri base id values associated with the tool run.</param>
         /// <param name="resolvedUri">The reconstructed absolute URI or null (if an absolute URI cannot be reconstructed).</param>
         /// <returns></returns>

src/Sarif/Core/SarifLog.cs

@@ -75,7 +75,7 @@ public void Save(string sarifFilePath)
         /// <summary>
         ///  Write a SARIF log to a destination stream.
         /// </summary>
-        /// <param name="streamWriter">Stream to write SARIF to</param>
+        /// <param name="stream">Stream to write SARIF to</param>
         public void Save(Stream stream)
         {
             using (StreamWriter streamWriter = new StreamWriter(stream))

src/Sarif/Core/StackFrame.cs

@@ -20,7 +20,7 @@ public partial class StackFrame
         /// <summary>
         /// Creates a SARIF StackFrame instance from a .NET StackFrame instance
         /// </summary>
-        /// <param name="stackTrace"></param>
+        /// <param name="dotNetStackFrame"></param>
         /// <returns></returns>
         public static StackFrame Create(System.Diagnostics.StackFrame dotNetStackFrame)
         {

src/Sarif/IAnalysisLogger.cs

@@ -37,6 +37,7 @@ public interface IAnalysisLogger
         /// Log a simple message for display to users (which 
         /// will not be persisted to log files)
         /// </summary>
+        /// <param name="verbose"></param>
         /// <param name="message"></param>
         void LogMessage(bool verbose, string message);
     }

src/Sarif/IResultLogWriter.cs

@@ -14,8 +14,7 @@ public interface IResultLogWriter
         /// results. A result might produce a new file object to be stored in run.files,
         /// for example, so run.Files will not be persisted on initialization.
         /// </summary>
-        /// <param name="id">A string that uniquely identifies a run.</param>
-        /// <param name="automationId">A global identifier for a run that permits correlation with a larger automation process.</param> 
+        /// <param name="run"></param>
         void Initialize(Run run);
 
         /// <summary>

src/Sarif/Processors/Generic/IFoldAction.cs

@@ -10,7 +10,7 @@ public interface IFoldAction<T> : IActionWrapper<T>
         /// <summary>
         /// Take an action on each sarif log, return the accumulated result.
         /// </summary>
-        /// <param name="list">List to fold over</param>
+        /// <param name="collection">Collection to fold over</param>
         /// <param name="accumulator">Accumulator to use.</param>
         /// <returns>The accumulated result.</returns>
         T Fold(IEnumerable<T> collection, T accumulator);

src/Sarif/Query/Evaluators/EvaluatorFactory.cs

@@ -18,7 +18,7 @@ public static class EvaluatorFactory
         ///  
         ///  int[] set;
         /// BitArray matches = new BitArray(set.Length);
-        //  evaluator.Evaluate(set, matches);
+        ///  evaluator.Evaluate(set, matches);
         /// </example>
         /// <param name="fieldType">Primitive type of array to build evaluator for</param>
         /// <param name="term">Query term with comparison and constant to evaluate against array</param>

src/Sarif/Writers/ResultLogJsonWriter.cs

@@ -49,8 +49,7 @@ public ResultLogJsonWriter(JsonWriter jsonWriter)
         /// Initializes the SARIF log by emitting properties and other constructs
         /// sufficient to being populating a run with results.
         /// </summary>
-        /// <param name="id">A string that uniquely identifies a run.</param>
-        /// <param name="automationId">A global identifier for a run that permits correlation with a larger automation process.</param>
+        /// <param name="run"></param>
         public void Initialize(Run run)
         {
             if (run == null)

src/WorkItems/FilingClient.cs

@@ -58,7 +58,7 @@ public FilingClient()
         /// <summary>
         /// Asynchronously file work items for the specified results.
         /// </summary>
-        /// <param name="workItemFilingMetadata">
+        /// <param name="workItemModels">
         /// Describes the work items to be filed.
         /// </param>
         /// <returns>

src/WorkItems/IVssConnection.cs

@@ -21,9 +21,8 @@ internal interface IVssConnection: IDisposable
         Task ConnectAsync(Uri accountUri, string personalAccessToken);
 
         /// <summary>
-        ///  Interface abstraction for VssConnection.GetClientAsync
+        /// Interface abstraction for VssConnection.GetClientAsync
         /// </summary>
-        /// <typeparam name="T"></typeparam>
         /// <returns></returns>
         Task<IWorkItemTrackingHttpClient> GetClientAsync();
     }

src/build.props

@@ -4,6 +4,7 @@
   <PropertyGroup>
     <TargetFrameworks>netcoreapp2.1;net461</TargetFrameworks>
     <LangVersion>8.0</LangVersion>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <PropertyGroup Label="AssemblyAttributes">