Include XML documentation in packages

- Include XML documentation in NuGet packages.
- Fix incorrect XML documentation references.

Author: martincostello

CHANGELOG.md

@@ -44,6 +44,9 @@
 
 ### New features
 
+* Include XML documentation in the `Grafana.OpenTelemetry` and
+  `Grafana.OpenTelemetry.Base` NuGet packages.
+  [#295](https://github.com/grafana/grafana-opentelemetry-dotnet/pull/295)
 * Enable metrics for SQL Client instrumentation
   ([#145](https://github.com/grafana/grafana-opentelemetry-dotnet/pull/145))
 * Use 1.12.0 of OpenTelemetry ([#145](https://github.com/grafana/grafana-opentelemetry-dotnet/pull/145))

src/Grafana.OpenTelemetry.Base/ExporterSettings/ExporterSettings.cs

@@ -45,7 +45,7 @@ public abstract class ExporterSettings
 
         /// <summary>
         /// Applies the exporter settings by initializing an exporter on the
-        /// given <see cref="ILoggingBuilder"/>.
+        /// given <see cref="Microsoft.Extensions.Logging.ILoggingBuilder"/>.
         /// </summary>
         /// <param name="options">A <see cref="OpenTelemetryLoggerOptions"/> instance.</param>
         internal abstract void Apply(OpenTelemetryLoggerOptions options);

src/Grafana.OpenTelemetry.Base/Grafana.OpenTelemetry.Base.csproj

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <Description>Minimal Grafana distribution of OpenTelemetry .NET</Description>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <TargetFrameworks>net8.0;netstandard2.0;net462</TargetFrameworks>
   </PropertyGroup>

src/Grafana.OpenTelemetry/Grafana.OpenTelemetry.csproj

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <Description>Full Grafana distribution of OpenTelemetry .NET</Description>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <TargetFrameworks>net8.0;netstandard2.0;net462</TargetFrameworks>
   </PropertyGroup>

src/Grafana.OpenTelemetry/OpenTelemetryBuilderExtension.cs

@@ -11,7 +11,7 @@
 namespace Grafana.OpenTelemetry
 {
     /// <summary>
-    /// Extension for the <see cref="OpenTelemetry.OpenTelemetryBuilder"/> provided by the OpenTelemetry .NET distribution 
+    /// Extension for the <see cref="IOpenTelemetryBuilder"/> provided by the OpenTelemetry .NET distribution 
     /// for Grafana.
     ///
     /// This is used for easier configuration for ASP.NET Core projects.