chore: Miscellaneous code cleanup, build warning change (#3428)

Author: tippmar-nr

.editorconfig

@@ -22,6 +22,12 @@ charset = utf-8 # supposed to get rid of the BOM issue
 dotnet_sort_system_directives_first = true
 dotnet_separate_import_directive_groups = false
 
+# save for later, only enabled for the `src` folder now
+# IDE0005: Using directive is unnecessary
+#dotnet_diagnostic.IDE0005.severity = warning
+# CS1591: Missing XML comment for publicly visible type or member
+#dotnet_diagnostic.CS1591.severity = none
+
 # this. preferences
 dotnet_style_qualification_for_field = false:silent
 dotnet_style_qualification_for_property = false:silent

Directory.Build.props

@@ -3,7 +3,9 @@
     <LangVersion>default</LangVersion>
     <RootProjectDirectory>$(MSBuildThisFileDirectory)</RootProjectDirectory>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-      <!-- Disable SDK’s pruning of (apparently) unused PackageReferences -->
+    <!-- Disable SDK’s pruning of (apparently) unused PackageReferences -->
     <RestoreEnablePackagePruning>false</RestoreEnablePackagePruning>
+    <EnforceCodeStyleInBuild>true</EnforceCodeStyleInBuild>
+    <!-- save for later <GenerateDocumentationFile>true</GenerateDocumentationFile>-->
   </PropertyGroup>
 </Project>

src/.editorconfig

@@ -0,0 +1,6 @@
+[*.{cs,vb}]
+
+# IDE0005: Using directive is unnecessary
+dotnet_diagnostic.IDE0005.severity = warning
+# CS1591: Missing XML comment for publicly visible type or member
+dotnet_diagnostic.CS1591.severity = none

src/Agent/NewRelic/Agent/Core/AgentHealth/HealthCheck.cs

@@ -20,7 +20,6 @@ public class HealthCheck
     /// <summary>
     /// Set the health status of the agent, but only update changed values.
     /// </summary>
-    /// <param name="healthy"></param>
     /// <param name="healthStatus"></param>
     /// <param name="statusParams"></param>
     public void TrySetHealth((bool IsHealthy, string Code, string Status) healthStatus, params string[] statusParams)

src/Agent/NewRelic/Agent/Core/AgentManager.cs

@@ -371,6 +371,7 @@ private void StopServices()
     /// <param name="argumentSignature"></param>
     /// <param name="invocationTarget"></param>
     /// <param name="arguments"></param>
+    /// <param name="functionId"></param>
     /// <returns>Returns an ITracer, although it is given as the much simpler Object;
     /// an Object is the preferred type because it has a trival type signature.</returns>
     public ITracer GetTracerImpl(string tracerFactoryName, uint tracerArguments, string metricName, string assemblyName, Type type, string typeName, string methodName, string argumentSignature, object invocationTarget, object[] arguments, ulong functionId)

src/Agent/NewRelic/Agent/Core/AgentShim.cs

@@ -157,8 +157,9 @@ public static Action<object, Exception> GetFinishTracerDelegate(
     /// <param name="argumentSignature"></param>
     /// <param name="invocationTarget"></param>
     /// <param name="args"></param>
+    /// <param name="functionId"></param>
     /// <returns></returns>
-    /// <returns>Returns an Action<object, Exception> delegate which invokes ITracer.Finish.  
+    /// <returns>Returns an Action&lt;object, Exception&gt; delegate which invokes ITracer.Finish.  
     /// We can directly invoke this delegate instead of using reflection.  Null should never be returned.</returns>
     /// <exception cref="System.ArgumentNullException"> thrown if any one of <paramref name="assemblyName"/>, <paramref name="type"/>,
     /// <paramref name="typeName"/>, <paramref name="methodName"/>, <paramref name="argumentSignature"/> or <paramref name="args"/> is null. 

src/Agent/NewRelic/Agent/Core/Aggregators/MetricStatsCollectionQueue.cs

@@ -51,7 +51,7 @@ public bool MergeMetrics(IAllMetricStatsCollection metrics)
     /// wait for us to finish before fetching/replacing the entire queue
     /// </summary>
     /// <param name="statsCollectionQueue"></param>
-    /// <param name="metric"></param>
+    /// <param name="metrics"></param>
     private void AddMetricsToCollection(ConcurrentQueue<MetricStatsCollection> statsCollectionQueue, IAllMetricStatsCollection metrics)
     {
         MetricStatsCollection statsCollectionToMergeWith = null;

src/Agent/NewRelic/Agent/Core/Api/AgentApi.cs

@@ -534,6 +534,7 @@ public static string GetBrowserTimingHeader(string nonce)
     /// Obsolete method that used to return the html snippet to be inserted into the footer of html pages as part of Real User Monitoring.
     /// Now only returns and empty string.
     /// Supports web applications only.
+    /// </summary>
     /// <returns>An empty string.</returns>
     [Obsolete("This method does nothing in version 9.x+ of the Agent.")]
     public static string GetBrowserTimingFooter()

src/Agent/NewRelic/Agent/Core/Api/AgentApiImplementation.cs

@@ -442,7 +442,7 @@ private void AddUserAttributeToCurrentTransaction(string key, object value)
 
     /// <summary> Set the name of the current transaction. Supports web applications only. </summary>
     ///
-    /// <exception cref="ArgumentNullException"> Thrown when <paramref name="key"/> is null. </exception>
+    /// <exception cref="ArgumentNullException"> Thrown when <paramref name="name"/> is null. </exception>
     ///
     /// <param name="category"> The category of this transaction, used to distinguish different types
     /// of transactions. Only the first 1000 characters are retained.  If null is passed, the

src/Agent/NewRelic/Agent/Core/Attributes/AttributeDefinition.cs

@@ -397,7 +397,7 @@ public AttributeDefinition(string name, AttributeClassification classification,
     /// 
     /// </summary>
     /// <param name="collection"></param>
-    /// <param name="getValFx">Function in users code to obtain the value.  Wrapped in a delegate
+    /// <param name="getInputValFx">Function in users code to obtain the value.  Wrapped in a delegate
     /// so as to not run if it is deemed not necessary</param>
     /// <returns>true if the value was set</returns>
     public bool TrySetValue(IAttributeValueCollection collection, Func<TInput> getInputValFx)